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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qdocgenerator.h"
#include <QtCore/qdir.h>
#include <iostream>
namespace QDocGenerator {
// See definition of idstring and licenseid in https://spdx.org/spdx-specification-21-web-version
static bool isSpdxLicenseId(const QString &str) {
if (str.isEmpty())
return false;
for (auto iter(str.cbegin()); iter != str.cend(); ++iter) {
const QChar c = *iter;
if (!((c >= QLatin1Char('A') && c <= QLatin1Char('Z'))
|| (c >= QLatin1Char('a') && c <= QLatin1Char('z'))
|| (c >= QLatin1Char('0') && c <= QLatin1Char('9'))
|| (c == QLatin1Char('-')) || (c == QLatin1Char('.'))))
return false;
}
return true;
}
static QString languageJoin(const QStringList &list)
{
QString result;
for (int i = 0; i < list.size(); ++i) {
QString delimiter = QStringLiteral(", ");
if (i == list.size() - 1) // last item
delimiter.clear();
else if (list.size() == 2)
delimiter = QStringLiteral(" and ");
else if (list.size() > 2 && i == list.size() - 2)
delimiter = QStringLiteral(", and "); // oxford comma
result += list[i] + delimiter;
}
return result;
}
static void generate(QTextStream &out, const Package &package, const QDir &baseDir,
LogLevel logLevel)
{
out << "/*!\n\n";
for (const QString &part: package.qtParts)
out << "\\ingroup attributions-" << part << "\n";
if (package.qtParts.contains(QLatin1String("libs"))) {
// show up in xxx-index.html page of module
out << "\\ingroup attributions-" << package.qdocModule << "\n";
// include in '\generatelist annotatedattributions'
out << "\\page " << package.qdocModule << "-attribution-" << package.id
<< ".html attribution\n";
} else {
out << "\\page " << package.qdocModule << "-attribution-" << package.id
<< ".html \n";
}
out << "\\target " << package.id << "\n\n";
out << "\\title " << package.name;
if (!package.version.isEmpty())
out << ", version " << package.version;
out << "\n\n\\brief " << package.license << "\n\n";
if (!package.description.isEmpty())
out << package.description << "\n\n";
if (!package.qtUsage.isEmpty())
out << package.qtUsage << "\n\n";
QStringList sourcePaths;
if (package.files.isEmpty()) {
sourcePaths << baseDir.relativeFilePath(package.path);
} else {
const QDir packageDir(package.path);
for (const QString &filePath: package.files) {
const QString absolutePath = packageDir.absoluteFilePath(filePath);
sourcePaths << baseDir.relativeFilePath(absolutePath);
}
}
out << "The sources can be found in " << languageJoin(sourcePaths) << ".\n\n";
const bool hasPackageVersion = !package.version.isEmpty();
const bool hasPackageDownloadLocation = !package.downloadLocation.isEmpty();
if (!package.homepage.isEmpty()) {
out << "\\l{" << package.homepage << "}{Project Homepage}";
if (hasPackageVersion)
out << ", ";
}
if (hasPackageVersion) {
out << "upstream version: ";
if (hasPackageDownloadLocation)
out << "\\l{" << package.downloadLocation << "}{";
out << package.version;
if (hasPackageDownloadLocation)
out << "}";
}
out << "\n\n";
QString copyright;
if (!package.copyright.isEmpty())
copyright = package.copyright;
if (!package.copyrightFile.isEmpty()) {
const QDir packageDir(package.path);
QFile file(QDir(package.path).absoluteFilePath(package.copyrightFile));
if (!file.open(QIODevice::ReadOnly)) {
if (logLevel != SilentLog) {
std::cerr << qPrintable(
tr("Path %1 : cannot open copyright file %2.\n")
.arg(QDir::toNativeSeparators(package.path))
.arg(QDir::toNativeSeparators(package.copyrightFile)));
copyright = QString::fromUtf8(file.readAll());
}
}
}
if (!copyright.isEmpty())
out << "\n\\badcode\n" << copyright << "\n\\endcode\n\n";
if (isSpdxLicenseId(package.licenseId) && package.licenseId != QLatin1String("NONE")) {
out << "\\l{https://spdx.org/licenses/" << package.licenseId << ".html}"
<< "{" << package.license << "}.\n\n";
} else if (package.licenseId.startsWith(QLatin1String("urn:dje:license:"))) {
out << "\\l{https://enterprise.dejacode.com/licenses/public/" << package.licenseId.mid(16)
<< "/}{" << package.license << "}.\n\n";
} else {
out << package.license << ".\n\n";
}
foreach (const QString &licenseFile, package.licenseFiles) {
QFile file(licenseFile);
if (!file.open(QIODevice::ReadOnly)) {
if (logLevel != SilentLog) {
std::cerr << qPrintable(tr("Path %1 : cannot open license file %2.\n")
.arg(QDir::toNativeSeparators(package.path))
.arg(QDir::toNativeSeparators(licenseFile)));
out << "*/\n";
}
return;
}
out << "\\badcode\n";
out << QString::fromUtf8(file.readAll()).trimmed();
out << "\n\\endcode\n\n";
}
out << "*/\n";
}
void generate(QTextStream &out, const QList<Package> &packages, const QString &baseDirectory,
LogLevel logLevel)
{
if (logLevel == VerboseLog)
std::cerr << qPrintable(tr("Generating qdoc file...")) << std::endl;
QDir baseDir(baseDirectory);
for (const Package &package : packages)
generate(out, package, baseDir, logLevel);
}
} // namespace QDocGenerator
|
