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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the tools applications 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$
**
****************************************************************************/
/*
tree.h
*/
#ifndef TREE_H
#define TREE_H
#include "node.h"
#include <QDomElement>
#include <QXmlStreamWriter>
QT_BEGIN_NAMESPACE
class QStringList;
class TreePrivate;
class Tree
{
public:
enum FindFlag { SearchBaseClasses = 0x1,
SearchEnumValues = 0x2,
NonFunction = 0x4 };
Tree();
~Tree();
Node* findNode(const QStringList &path,
Node* relative=0,
int findFlags=0,
const Node* self=0);
Node* findNode(const QStringList &path,
Node::Type type,
Node* relative = 0,
int findFlags = 0);
FunctionNode *findFunctionNode(const QStringList &path,
Node *relative = 0,
int findFlags = 0);
FunctionNode *findFunctionNode(const QStringList &parentPath,
const FunctionNode *clone,
Node *relative = 0,
int findFlags = 0);
void addBaseClass(ClassNode *subclass,
Node::Access access,
const QStringList &basePath,
const QString &dataTypeWithTemplateArgs,
InnerNode *parent = 0);
void addPropertyFunction(PropertyNode *property,
const QString &funcName,
PropertyNode::FunctionRole funcRole);
void addToGroup(Node *node, const QString &group);
void addToPublicGroup(Node *node, const QString &group);
QMultiMap<QString, Node *> groups() const;
QMultiMap<QString, QString> publicGroups() const;
void resolveInheritance(NamespaceNode *rootNode = 0);
void resolveProperties();
void resolveGroups();
void resolveTargets();
void fixInheritance(NamespaceNode *rootNode = 0);
void setVersion(const QString &version) { vers = version; }
NamespaceNode *root() { return &roo; }
QString version() const { return vers; }
const Node* findNode(const QStringList &path,
const Node* relative = 0,
int findFlags = 0,
const Node* self=0) const;
const Node* findNode(const QStringList &path,
Node::Type type, const
Node* relative = 0,
int findFlags = 0) const;
const FunctionNode *findFunctionNode(const QStringList &path,
const Node *relative = 0,
int findFlags = 0) const;
const FunctionNode *findFunctionNode(const QStringList &parentPath,
const FunctionNode *clone,
const Node *relative = 0,
int findFlags = 0) const;
const FakeNode *findFakeNodeByTitle(const QString &title) const;
const Node *findUnambiguousTarget(const QString &target, Atom *&atom) const;
Atom *findTarget(const QString &target, const Node *node) const;
const NamespaceNode *root() const { return &roo; }
void readIndexes(const QStringList &indexFiles);
bool generateIndexSection(QXmlStreamWriter &writer, const Node *node,
bool generateInternalNodes = false) const;
void generateIndexSections(QXmlStreamWriter &writer, const Node *node,
bool generateInternalNodes = false) const;
void generateIndex(const QString &fileName,
const QString &url,
const QString &title,
bool generateInternalNodes = false) const;
void generateTagFileCompounds(QXmlStreamWriter &writer,
const InnerNode *inner) const;
void generateTagFileMembers(QXmlStreamWriter &writer,
const InnerNode *inner) const;
void generateTagFile(const QString &fileName) const;
void addExternalLink(const QString &url, const Node *relative);
QString fullDocumentName(const Node *node) const;
QString fullDocumentLocation(const Node *node) const;
private:
void resolveInheritance(int pass, ClassNode *classe);
FunctionNode *findVirtualFunctionInBaseClasses(ClassNode *classe,
FunctionNode *clone);
void fixPropertyUsingBaseClasses(ClassNode *classe, PropertyNode *property);
NodeList allBaseClasses(const ClassNode *classe) const;
void readIndexFile(const QString &path);
void readIndexSection(const QDomElement &element, InnerNode *parent,
const QString &indexUrl);
QString readIndexText(const QDomElement &element);
void resolveIndex();
private:
NamespaceNode roo;
QString vers;
TreePrivate *priv;
};
QT_END_NAMESPACE
#endif
|
