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
|
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef HELPPROJECTWRITER_H
#define HELPPROJECTWRITER_H
#include "node.h"
#include <QtCore/qstring.h>
#include <QtCore/qxmlstream.h>
#include <utility>
QT_BEGIN_NAMESPACE
class QDocDatabase;
class Generator;
using NodeTypeSet = QSet<unsigned char>;
struct SubProject
{
QString m_title {};
QString m_indexTitle {};
NodeTypeSet m_selectors {};
bool m_sortPages {};
QString m_type {};
QHash<QString, const Node *> m_nodes {};
QStringList m_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 m_name {};
QStringList m_ids {};
QString m_ref {};
Keyword(QString name, const QString &id, QString ref)
: m_name(std::move(name)), m_ids(QStringList(id)), m_ref(std::move(ref))
{
}
Keyword(QString name, QStringList ids, QString ref)
: m_name(std::move(name)), m_ids(std::move(ids)), m_ref(std::move(ref))
{
}
bool operator<(const Keyword &o) const
{
// Order by name; use ref as a secondary sort key
return (m_name == o.m_name) ? m_ref < o.m_ref : m_name < o.m_name;
}
};
struct HelpProject
{
using NodeStatusSet = QSet<unsigned char>;
QString m_name {};
QString m_helpNamespace {};
QString m_virtualFolder {};
QString m_version {};
QString m_fileName {};
QString m_indexRoot {};
QString m_indexTitle {};
QList<Keyword> m_keywords {};
QSet<QString> m_files {};
QSet<QString> m_extraFiles {};
QSet<QString> m_filterAttributes {};
QHash<QString, QSet<QString>> m_customFilters {};
QSet<QString> m_excluded {};
QList<SubProject> m_subprojects {};
QHash<const Node *, NodeStatusSet> m_memberStatus {};
bool m_includeIndexNodes {};
};
class HelpProjectWriter
{
public:
HelpProjectWriter(const QString &defaultFileName, Generator *g);
void reset(const QString &defaultFileName, Generator *g);
void addExtraFile(const QString &file);
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 *m_qdb {};
Generator *m_gen {};
QString m_outputDir {};
QList<HelpProject> m_projects {};
};
QT_END_NAMESPACE
#endif
|
