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
|
// 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 SECTIONS_H
#define SECTIONS_H
#include "node.h"
QT_BEGIN_NAMESPACE
class Aggregate;
typedef std::pair<const QmlTypeNode *, NodeVector> ClassNodes;
typedef QList<ClassNodes> ClassNodesList;
class Section
{
public:
enum Style { Summary, Details, AllMembers, Accessors };
public:
Section(
QString title, QString singular, QString plural,
QString divclass, Style style
) : m_title{title}, m_singular{singular}, m_plural{plural},
m_divClass{divclass}, m_style{style}
{}
~Section();
void insert(Node *node);
bool insertReimplementedMember(Node *node);
void appendMember(Node *node) { m_members.append(node); }
void clear();
void reduce();
[[nodiscard]] bool isEmpty() const
{
return (m_members.isEmpty() && m_inheritedMembers.isEmpty()
&& m_reimplementedMemberMap.isEmpty() && m_classNodesList.isEmpty());
}
[[nodiscard]] Style style() const { return m_style; }
[[nodiscard]] const QString &title() const { return m_title; }
[[nodiscard]] const QString &divClass() const { return m_divClass; }
[[nodiscard]] const QString &singular() const { return m_singular; }
[[nodiscard]] const QString &plural() const { return m_plural; }
[[nodiscard]] const NodeVector &members() const { return m_members; }
[[nodiscard]] const NodeVector &reimplementedMembers() const { return m_reimplementedMembers; }
[[nodiscard]] const QList<std::pair<Aggregate *, int>> &inheritedMembers() const
{
return m_inheritedMembers;
}
ClassNodesList &classNodesList() { return m_classNodesList; }
[[nodiscard]] const NodeVector &obsoleteMembers() const { return m_obsoleteMembers; }
void appendMembers(const NodeVector &nv) { m_members.append(nv); }
[[nodiscard]] const Aggregate *aggregate() const { return m_aggregate; }
void setAggregate(Aggregate *t) { m_aggregate = t; }
private:
QString m_title {};
QString m_singular {};
QString m_plural {};
QString m_divClass {};
Style m_style {};
Aggregate *m_aggregate { nullptr };
NodeVector m_members {};
NodeVector m_obsoleteMembers {};
NodeVector m_reimplementedMembers {};
QList<std::pair<Aggregate *, int>> m_inheritedMembers {};
ClassNodesList m_classNodesList {};
QMultiMap<QString, Node *> m_reimplementedMemberMap {};
};
typedef QList<Section> SectionVector;
typedef QList<const Section *> SectionPtrVector;
class Sections
{
public:
enum VectorIndex {
PublicTypes = 0,
DetailsMemberTypes = 0,
SinceNamespaces = 0,
StdNamespaces = 0,
QmlProperties = 0,
Properties = 1,
DetailsProperties = 1,
SinceClasses = 1,
StdClasses = 1,
QmlAttachedProperties = 1,
PublicFunctions = 2,
DetailsMemberFunctions = 2,
SinceMemberFunctions = 2,
StdTypes = 2,
QmlSignals = 2,
PublicSlots = 3,
DetailsMemberVariables = 3,
SinceNamespaceFunctions = 3,
StdVariables = 3,
QmlSignalHandlers = 3,
Signals = 4,
SinceGlobalFunctions = 4,
DetailsRelatedNonmembers = 4,
StdStaticVariables = 4,
QmlAttachedSignals = 4,
PublicVariables = 5,
SinceMacros = 5,
DetailsMacros = 5,
StdFunctions = 5,
QmlMethods = 5,
StaticPublicMembers = 6,
SinceEnumTypes = 6,
StdMacros = 6,
QmlAttachedMethods = 6,
SinceEnumValues = 7,
ProtectedTypes = 7,
SinceTypeAliases = 8,
ProtectedFunctions = 8,
SinceProperties = 9,
ProtectedSlots = 9,
SinceVariables = 10,
ProtectedVariables = 10,
SinceQmlTypes = 11,
StaticProtectedMembers = 11,
SinceQmlProperties = 12,
PrivateTypes = 12,
SinceQmlSignals = 13,
PrivateFunctions = 13,
SinceQmlSignalHandlers = 14,
PrivateSlots = 14,
SinceQmlMethods = 15,
StaticPrivateMembers = 15,
RelatedNonmembers = 16,
Macros = 17
};
explicit Sections(Aggregate *aggregate);
explicit Sections(const NodeMultiMap &nsmap);
~Sections();
void clear(SectionVector &v);
void reduce(SectionVector &v);
void buildStdRefPageSections();
void buildStdCppClassRefPageSections();
void buildStdQmlTypeRefPageSections();
bool hasObsoleteMembers(SectionPtrVector *summary_spv, SectionPtrVector *details_spv) const;
static Section &allMembersSection() { return s_allMembers[0]; }
SectionVector &sinceSections() { return s_sinceSections; }
SectionVector &stdSummarySections() { return s_stdSummarySections; }
SectionVector &stdDetailsSections() { return s_stdDetailsSections; }
SectionVector &stdCppClassSummarySections() { return s_stdCppClassSummarySections; }
SectionVector &stdCppClassDetailsSections() { return s_stdCppClassDetailsSections; }
SectionVector &stdQmlTypeSummarySections() { return s_stdQmlTypeSummarySections; }
SectionVector &stdQmlTypeDetailsSections() { return s_stdQmlTypeDetailsSections; }
[[nodiscard]] const SectionVector &stdSummarySections() const { return s_stdSummarySections; }
[[nodiscard]] const SectionVector &stdDetailsSections() const { return s_stdDetailsSections; }
[[nodiscard]] const SectionVector &stdCppClassSummarySections() const
{
return s_stdCppClassSummarySections;
}
[[nodiscard]] const SectionVector &stdCppClassDetailsSections() const
{
return s_stdCppClassDetailsSections;
}
[[nodiscard]] const SectionVector &stdQmlTypeSummarySections() const
{
return s_stdQmlTypeSummarySections;
}
[[nodiscard]] const SectionVector &stdQmlTypeDetailsSections() const
{
return s_stdQmlTypeDetailsSections;
}
[[nodiscard]] Aggregate *aggregate() const { return m_aggregate; }
private:
void stdRefPageSwitch(SectionVector &v, Node *n, Node *t = nullptr);
void distributeNodeInSummaryVector(SectionVector &sv, Node *n);
void distributeNodeInDetailsVector(SectionVector &dv, Node *n);
void distributeQmlNodeInDetailsVector(SectionVector &dv, Node *n);
void distributeQmlNodeInSummaryVector(SectionVector &sv, Node *n, bool sharing = false);
void initAggregate(SectionVector &v, Aggregate *aggregate);
private:
Aggregate *m_aggregate { nullptr };
static SectionVector s_stdSummarySections;
static SectionVector s_stdDetailsSections;
static SectionVector s_stdCppClassSummarySections;
static SectionVector s_stdCppClassDetailsSections;
static SectionVector s_stdQmlTypeSummarySections;
static SectionVector s_stdQmlTypeDetailsSections;
static SectionVector s_sinceSections;
static SectionVector s_allMembers;
};
QT_END_NAMESPACE
#endif
|
