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
|
/****************************************************************************
**
** Copyright (C) 2019 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$
**
****************************************************************************/
#ifndef HELPPROJECTWRITER_H
#define HELPPROJECTWRITER_H
#include "node.h"
#include <QtCore/qstring.h>
#include <QtCore/qxmlstream.h>
QT_BEGIN_NAMESPACE
class QDocDatabase;
class Generator;
typedef QPair<QString, const Node *> QStringNodePair;
using NodeTypeSet = QSet<unsigned char>;
struct SubProject
{
QString title;
QString indexTitle;
NodeTypeSet selectors;
bool sortPages;
QString type;
QHash<QString, const Node *> nodes;
QStringList groups;
};
/*
* Name is the human-readable name to be shown in Assistant.
* Ids is a list of unique identifiers.
* Ref is the location of the documentation for the keyword.
*/
struct Keyword {
QString name;
QStringList ids;
QString ref;
Keyword(QString name, QString id, QString ref) : name(name), ids(QStringList(id)), ref(ref) {}
Keyword(QString name, QStringList ids, QString ref) : name(name), ids(ids), ref(ref) {}
bool operator<(const Keyword &o) const
{
// Order by name; use id as a secondary sort key
return (name == o.name) ? ids.last() < o.ids.last() : name < o.name;
}
};
struct HelpProject
{
using NodeStatusSet = QSet<unsigned char>;
QString name;
QString helpNamespace;
QString virtualFolder;
QString version;
QString fileName;
QString indexRoot;
QString indexTitle;
QList<Keyword> keywords;
QSet<QString> files;
QSet<QString> extraFiles;
QSet<QString> filterAttributes;
QHash<QString, QSet<QString>> customFilters;
QSet<QString> excluded;
QList<SubProject> subprojects;
QHash<const Node *, NodeStatusSet> memberStatus;
bool includeIndexNodes;
};
class HelpProjectWriter
{
public:
HelpProjectWriter(const QString &defaultFileName, Generator *g);
void reset(const QString &defaultFileName, Generator *g);
void addExtraFile(const QString &file);
void addExtraFiles(const QSet<QString> &files);
void generate();
private:
void generateProject(HelpProject &project);
void generateSections(HelpProject &project, QXmlStreamWriter &writer, const Node *node);
bool generateSection(HelpProject &project, QXmlStreamWriter &writer, const Node *node);
Keyword keywordDetails(const Node *node) const;
void writeHashFile(QFile &file);
void writeNode(HelpProject &project, QXmlStreamWriter &writer, const Node *node);
void readSelectors(SubProject &subproject, const QStringList &selectors);
void addMembers(HelpProject &project, QXmlStreamWriter &writer, const Node *node);
void writeSection(QXmlStreamWriter &writer, const QString &path, const QString &value);
QDocDatabase *qdb_;
Generator *gen_;
QString outputDir;
QList<HelpProject> projects;
};
QT_END_NAMESPACE
#endif
|
