source: trunk/tools/qdoc3/tree.h

Last change on this file was 846, checked in by Dmitry A. Kuminov, 14 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.
File size: 6.7 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the tools applications of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*
43 tree.h
44*/
45
46#ifndef TREE_H
47#define TREE_H
48
49#include "node.h"
50#include <QDomElement>
51#include <QXmlStreamWriter>
52
53QT_BEGIN_NAMESPACE
54
55class QStringList;
56class TreePrivate;
57
58class Tree
59{
60 public:
61 enum FindFlag { SearchBaseClasses = 0x1,
62 SearchEnumValues = 0x2,
63 NonFunction = 0x4 };
64
65 Tree();
66 ~Tree();
67
68 Node* findNode(const QStringList &path,
69 Node* relative=0,
70 int findFlags=0,
71 const Node* self=0);
72 Node* findNode(const QStringList &path,
73 Node::Type type,
74 Node* relative = 0,
75 int findFlags = 0);
76 FunctionNode *findFunctionNode(const QStringList &path,
77 Node *relative = 0,
78 int findFlags = 0);
79 FunctionNode *findFunctionNode(const QStringList &parentPath,
80 const FunctionNode *clone,
81 Node *relative = 0,
82 int findFlags = 0);
83 void addBaseClass(ClassNode *subclass,
84 Node::Access access,
85 const QStringList &basePath,
86 const QString &dataTypeWithTemplateArgs,
87 InnerNode *parent = 0);
88 void addPropertyFunction(PropertyNode *property,
89 const QString &funcName,
90 PropertyNode::FunctionRole funcRole);
91 void addToGroup(Node *node, const QString &group);
92 void addToPublicGroup(Node *node, const QString &group);
93 QMultiMap<QString, Node *> groups() const;
94 QMultiMap<QString, QString> publicGroups() const;
95 void resolveInheritance(NamespaceNode *rootNode = 0);
96 void resolveProperties();
97 void resolveGroups();
98 void resolveTargets();
99 void fixInheritance(NamespaceNode *rootNode = 0);
100 void setVersion(const QString &version) { vers = version; }
101 NamespaceNode *root() { return &roo; }
102
103 QString version() const { return vers; }
104 const Node* findNode(const QStringList &path,
105 const Node* relative = 0,
106 int findFlags = 0,
107 const Node* self=0) const;
108 const Node* findNode(const QStringList &path,
109 Node::Type type, const
110 Node* relative = 0,
111 int findFlags = 0) const;
112 const FunctionNode *findFunctionNode(const QStringList &path,
113 const Node *relative = 0,
114 int findFlags = 0) const;
115 const FunctionNode *findFunctionNode(const QStringList &parentPath,
116 const FunctionNode *clone,
117 const Node *relative = 0,
118 int findFlags = 0) const;
119 const FakeNode *findFakeNodeByTitle(const QString &title) const;
120 const Node *findUnambiguousTarget(const QString &target, Atom *&atom) const;
121 Atom *findTarget(const QString &target, const Node *node) const;
122 const NamespaceNode *root() const { return &roo; }
123 void readIndexes(const QStringList &indexFiles);
124 bool generateIndexSection(QXmlStreamWriter &writer, const Node *node,
125 bool generateInternalNodes = false) const;
126 void generateIndexSections(QXmlStreamWriter &writer, const Node *node,
127 bool generateInternalNodes = false) const;
128 void generateIndex(const QString &fileName,
129 const QString &url,
130 const QString &title,
131 bool generateInternalNodes = false) const;
132 void generateTagFileCompounds(QXmlStreamWriter &writer,
133 const InnerNode *inner) const;
134 void generateTagFileMembers(QXmlStreamWriter &writer,
135 const InnerNode *inner) const;
136 void generateTagFile(const QString &fileName) const;
137 void addExternalLink(const QString &url, const Node *relative);
138 QString fullDocumentName(const Node *node) const;
139 QString fullDocumentLocation(const Node *node) const;
140
141 private:
142 void resolveInheritance(int pass, ClassNode *classe);
143 FunctionNode *findVirtualFunctionInBaseClasses(ClassNode *classe,
144 FunctionNode *clone);
145 void fixPropertyUsingBaseClasses(ClassNode *classe, PropertyNode *property);
146 NodeList allBaseClasses(const ClassNode *classe) const;
147 void readIndexFile(const QString &path);
148 void readIndexSection(const QDomElement &element, InnerNode *parent,
149 const QString &indexUrl);
150 QString readIndexText(const QDomElement &element);
151 void resolveIndex();
152
153 private:
154 NamespaceNode roo;
155 QString vers;
156 TreePrivate *priv;
157};
158
159QT_END_NAMESPACE
160
161#endif
Note: See TracBrowser for help on using the repository browser.