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
|
/****************************************************************************
**
** 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 QDOCINDEXFILES_H
#define QDOCINDEXFILES_H
#include "node.h"
#include "tree.h"
QT_BEGIN_NAMESPACE
class Atom;
class Generator;
class QStringList;
class QDocDatabase;
class WebXMLGenerator;
class QXmlStreamReader;
class QXmlStreamWriter;
class QXmlStreamAttributes;
// A callback interface for extending index sections
class IndexSectionWriter
{
public:
virtual ~IndexSectionWriter() {}
virtual void append(QXmlStreamWriter &writer, Node *node) = 0;
};
class QDocIndexFiles
{
friend class QDocDatabase;
friend class WebXMLGenerator; // for using generateIndexSections()
private:
static QDocIndexFiles *qdocIndexFiles();
static void destroyQDocIndexFiles();
QDocIndexFiles();
~QDocIndexFiles();
void readIndexes(const QStringList &indexFiles);
void readIndexFile(const QString &path);
void readIndexSection(QXmlStreamReader &reader, Node *current, const QString &indexUrl);
void insertTarget(TargetRec::TargetType type, const QXmlStreamAttributes &attributes,
Node *node);
void resolveIndex();
void generateIndex(const QString &fileName, const QString &url, const QString &title,
Generator *g);
void generateFunctionSection(QXmlStreamWriter &writer, FunctionNode *fn);
void generateFunctionSections(QXmlStreamWriter &writer, Aggregate *aggregate);
bool generateIndexSection(QXmlStreamWriter &writer, Node *node,
IndexSectionWriter *post = nullptr);
void generateIndexSections(QXmlStreamWriter &writer, Node *node,
IndexSectionWriter *post = nullptr);
private:
static QDocIndexFiles *qdocIndexFiles_;
QDocDatabase *qdb_;
Generator *gen_;
QString project_;
QVector<QPair<ClassNode *, QString>> basesList_;
bool storeLocationInfo_;
};
QT_END_NAMESPACE
#endif
|
