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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qhelpprojectdata_p.h"
#include <QtCore/QCoreApplication>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QStack>
#include <QtCore/QMap>
#include <QtCore/QRegExp>
#include <QtCore/QUrl>
#include <QtCore/QVariant>
#include <QtXml/QXmlStreamReader>
QT_BEGIN_NAMESPACE
class QHelpProjectDataPrivate : public QXmlStreamReader
{
public:
void readData(const QByteArray &contents);
QString virtualFolder;
QString namespaceName;
QString rootPath;
QStringList fileList;
QList<QHelpDataCustomFilter> customFilterList;
QList<QHelpDataFilterSection> filterSectionList;
QMap<QString, QVariant> metaData;
QString errorMsg;
private:
void readProject();
void readCustomFilter();
void readFilterSection();
void readTOC();
void readKeywords();
void readFiles();
void raiseUnknownTokenError();
void addMatchingFiles(const QString &pattern);
bool hasValidSyntax(const QString &nameSpace, const QString &vFolder) const;
QMap<QString, QStringList> dirEntriesCache;
};
void QHelpProjectDataPrivate::raiseUnknownTokenError()
{
raiseError(QCoreApplication::translate("QHelpProject", "Unknown token."));
}
void QHelpProjectDataPrivate::readData(const QByteArray &contents)
{
addData(contents);
while (!atEnd()) {
readNext();
if (isStartElement()) {
if (name() == QLatin1String("QtHelpProject")
&& attributes().value(QLatin1String("version")) == QLatin1String("1.0"))
readProject();
else
raiseError(QCoreApplication::translate("QHelpProject",
"Unknown token. Expected \"QtHelpProject\"!"));
}
}
if (hasError()) {
raiseError(QCoreApplication::translate("QHelpProject",
"Error in line %1: %2").arg(lineNumber())
.arg(errorString()));
}
}
void QHelpProjectDataPrivate::readProject()
{
while (!atEnd()) {
readNext();
if (isStartElement()) {
if (name() == QLatin1String("virtualFolder")) {
virtualFolder = readElementText();
if (!hasValidSyntax(QLatin1String("test"), virtualFolder))
raiseError(QCoreApplication::translate("QHelpProject",
"Virtual folder has invalid syntax."));
} else if (name() == QLatin1String("namespace")) {
namespaceName = readElementText();
if (!hasValidSyntax(namespaceName, QLatin1String("test")))
raiseError(QCoreApplication::translate("QHelpProject",
"Namespace has invalid syntax."));
} else if (name() == QLatin1String("customFilter")) {
readCustomFilter();
} else if (name() == QLatin1String("filterSection")) {
readFilterSection();
} else if (name() == QLatin1String("metaData")) {
QString n = attributes().value(QLatin1String("name")).toString();
if (!metaData.contains(n))
metaData[n]
= attributes().value(QLatin1String("value")).toString();
else
metaData.insert(n, attributes().
value(QLatin1String("value")).toString());
} else {
raiseUnknownTokenError();
}
} else if (isEndElement() && name() == QLatin1String("QtHelpProject")) {
if (namespaceName.isEmpty())
raiseError(QCoreApplication::translate("QHelpProject",
"Missing namespace in QtHelpProject."));
else if (virtualFolder.isEmpty())
raiseError(QCoreApplication::translate("QHelpProject",
"Missing virtual folder in QtHelpProject"));
break;
}
}
}
void QHelpProjectDataPrivate::readCustomFilter()
{
QHelpDataCustomFilter filter;
filter.name = attributes().value(QLatin1String("name")).toString();
while (!atEnd()) {
readNext();
if (isStartElement()) {
if (name() == QLatin1String("filterAttribute"))
filter.filterAttributes.append(readElementText());
else
raiseUnknownTokenError();
} else if (isEndElement() && name() == QLatin1String("customFilter")) {
break;
}
}
customFilterList.append(filter);
}
void QHelpProjectDataPrivate::readFilterSection()
{
filterSectionList.append(QHelpDataFilterSection());
while (!atEnd()) {
readNext();
if (isStartElement()) {
if (name() == QLatin1String("filterAttribute"))
filterSectionList.last().addFilterAttribute(readElementText());
else if (name() == QLatin1String("toc"))
readTOC();
else if (name() == QLatin1String("keywords"))
readKeywords();
else if (name() == QLatin1String("files"))
readFiles();
else
raiseUnknownTokenError();
} else if (isEndElement() && name() == QLatin1String("filterSection")) {
break;
}
}
}
void QHelpProjectDataPrivate::readTOC()
{
QStack<QHelpDataContentItem*> contentStack;
QHelpDataContentItem *itm = 0;
while (!atEnd()) {
readNext();
if (isStartElement()) {
if (name() == QLatin1String("section")) {
QString title = attributes().value(QLatin1String("title")).toString();
QString ref = attributes().value(QLatin1String("ref")).toString();
if (contentStack.isEmpty()) {
itm = new QHelpDataContentItem(0, title, ref);
filterSectionList.last().addContent(itm);
} else {
itm = new QHelpDataContentItem(contentStack.top(), title, ref);
}
contentStack.push(itm);
} else {
raiseUnknownTokenError();
}
} else if (isEndElement()) {
if (name() == QLatin1String("section")) {
contentStack.pop();
continue;
} else if (name() == QLatin1String("toc") && contentStack.isEmpty()) {
break;
} else {
raiseUnknownTokenError();
}
}
}
}
void QHelpProjectDataPrivate::readKeywords()
{
while (!atEnd()) {
readNext();
if (isStartElement()) {
if (name() == QLatin1String("keyword")) {
if (attributes().value(QLatin1String("ref")).toString().isEmpty()
|| (attributes().value(QLatin1String("name")).toString().isEmpty()
&& attributes().value(QLatin1String("id")).toString().isEmpty()))
raiseError(QCoreApplication::translate("QHelpProject",
"Missing attribute in keyword at line %1.")
.arg(lineNumber()));
filterSectionList.last()
.addIndex(QHelpDataIndexItem(attributes().
value(QLatin1String("name")).toString(),
attributes().value(QLatin1String("id")).toString(),
attributes().value(QLatin1String("ref")).toString()));
} else {
raiseUnknownTokenError();
}
} else if (isEndElement()) {
if (name() == QLatin1String("keyword"))
continue;
else if (name() == QLatin1String("keywords"))
break;
else
raiseUnknownTokenError();
}
}
}
void QHelpProjectDataPrivate::readFiles()
{
while (!atEnd()) {
readNext();
if (isStartElement()) {
if (name() == QLatin1String("file"))
addMatchingFiles(readElementText());
else
raiseUnknownTokenError();
} else if (isEndElement()) {
if (name() == QLatin1String("file"))
continue;
else if (name() == QLatin1String("files"))
break;
else
raiseUnknownTokenError();
}
}
}
// Expand file pattern and add matches into list. If the pattern does not match
// any files, insert the pattern itself so the QHelpGenerator will emit a
// meaningful warning later.
void QHelpProjectDataPrivate::addMatchingFiles(const QString &pattern)
{
// The pattern matching is expensive, so we skip it if no
// wildcard symbols occur in the string.
if (!pattern.contains('?') && !pattern.contains('*')
&& !pattern.contains('[') && !pattern.contains(']')) {
filterSectionList.last().addFile(pattern);
return;
}
QFileInfo fileInfo(rootPath + '/' + pattern);
const QDir &dir = fileInfo.dir();
const QString &path = dir.canonicalPath();
// QDir::entryList() is expensive, so we cache the results.
QMap<QString, QStringList>::ConstIterator it = dirEntriesCache.find(path);
const QStringList &entries = it != dirEntriesCache.constEnd() ?
it.value() : dir.entryList(QDir::Files);
if (it == dirEntriesCache.constEnd())
dirEntriesCache.insert(path, entries);
bool matchFound = false;
#ifdef Q_OS_WIN
Qt::CaseSensitivity cs = Qt::CaseInsensitive;
#else
Qt::CaseSensitivity cs = Qt::CaseSensitive;
#endif
QRegExp regExp(fileInfo.fileName(), cs, QRegExp::Wildcard);
foreach (const QString &file, entries) {
if (regExp.exactMatch(file)) {
matchFound = true;
filterSectionList.last().
addFile(QFileInfo(pattern).dir().path() + '/' + file);
}
}
if (!matchFound)
filterSectionList.last().addFile(pattern);
}
bool QHelpProjectDataPrivate::hasValidSyntax(const QString &nameSpace,
const QString &vFolder) const
{
const QLatin1Char slash('/');
if (nameSpace.contains(slash) || vFolder.contains(slash))
return false;
QUrl url;
const QLatin1String scheme("qthelp");
url.setScheme(scheme);
const QString canonicalNamespace = nameSpace.toLower();
url.setHost(canonicalNamespace);
url.setPath(vFolder);
const QString expectedUrl(scheme + QLatin1String("://")
+ canonicalNamespace + slash + vFolder);
return url.isValid() && url.toString() == expectedUrl;
}
/*!
\internal
\class QHelpProjectData
\since 4.4
\brief The QHelpProjectData class stores all information found
in a Qt help project file.
The structure is filled with data by calling readData(). The
specified file has to have the Qt help project file format in
order to be read successfully. Possible reading errors can be
retrieved by calling errorMessage().
*/
/*!
Constructs a Qt help project data structure.
*/
QHelpProjectData::QHelpProjectData()
{
d = new QHelpProjectDataPrivate;
}
/*!
Destroys the help project data.
*/
QHelpProjectData::~QHelpProjectData()
{
delete d;
}
/*!
Reads the file \a fileName and stores the help data. The file has to
have the Qt help project file format. Returns true if the file
was successfully read, otherwise false.
\sa errorMessage()
*/
bool QHelpProjectData::readData(const QString &fileName)
{
d->rootPath = QFileInfo(fileName).absolutePath();
QFile file(fileName);
if (!file.open(QIODevice::ReadOnly)) {
d->errorMsg = QCoreApplication::translate("QHelpProject",
"The input file %1 could not be opened!").arg(fileName);
return false;
}
d->readData(file.readAll());
return !d->hasError();
}
/*!
Returns an error message if the reading of the Qt help project
file failed. Otherwise, an empty QString is returned.
\sa readData()
*/
QString QHelpProjectData::errorMessage() const
{
if (d->hasError())
return d->errorString();
return d->errorMsg;
}
/*!
\internal
*/
QString QHelpProjectData::namespaceName() const
{
return d->namespaceName;
}
/*!
\internal
*/
QString QHelpProjectData::virtualFolder() const
{
return d->virtualFolder;
}
/*!
\internal
*/
QList<QHelpDataCustomFilter> QHelpProjectData::customFilters() const
{
return d->customFilterList;
}
/*!
\internal
*/
QList<QHelpDataFilterSection> QHelpProjectData::filterSections() const
{
return d->filterSectionList;
}
/*!
\internal
*/
QMap<QString, QVariant> QHelpProjectData::metaData() const
{
return d->metaData;
}
/*!
\internal
*/
QString QHelpProjectData::rootPath() const
{
return d->rootPath;
}
QT_END_NAMESPACE
|