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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.1, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*
pagegenerator.cpp
*/
#include <QtCore>
#include <qfile.h>
#include <qfileinfo.h>
#include "pagegenerator.h"
#include "tree.h"
QT_BEGIN_NAMESPACE
/*!
Nothing to do in the constructor.
*/
PageGenerator::PageGenerator()
{
// nothing.
}
/*!
The destructor
*/
PageGenerator::~PageGenerator()
{
while (!outStreamStack.isEmpty())
endSubPage();
}
/*!
This function is recursive.
*/
void PageGenerator::generateTree(const Tree *tree, CodeMarker *marker)
{
generateInnerNode(tree->root(), marker);
}
QString PageGenerator::fileBase(const Node *node)
{
if (node->relates())
node = node->relates();
else if (!node->isInnerNode()) {
node = node->parent();
#ifdef QDOC_QML
if (node->subType() == Node::QmlPropertyGroup) {
node = node->parent();
}
#endif
}
QString base = node->doc().baseName();
if (!base.isEmpty())
return base;
const Node *p = node;
forever {
base.prepend(p->name());
#ifdef QDOC_QML
/*
To avoid file name conflicts in the html directory,
we prepend "qml-" to the file name of QML element doc
files.
*/
if ((p->subType() == Node::QmlClass) ||
(p->subType() == Node::QmlPropertyGroup))
base.prepend("qml-");
else if ((p->type() == Node::QmlProperty) ||
(p->type() == Node::QmlSignal) ||
(p->type() == Node::QmlMethod))
base.prepend("qml-");
#endif
const Node *pp = p->parent();
if (!pp || pp->name().isEmpty() || pp->type() == Node::Fake)
break;
base.prepend(QLatin1Char('-'));
p = pp;
}
if (node->type() == Node::Fake) {
#ifdef QDOC2_COMPAT
if (base.endsWith(".html"))
base.truncate(base.length() - 5);
#endif
}
// the code below is effectively equivalent to:
// base.replace(QRegExp("[^A-Za-z0-9]+"), " ");
// base = base.trimmed();
// base.replace(" ", "-");
// base = base.toLower();
// as this function accounted for ~8% of total running time
// we optimize a bit...
QString res;
// +5 prevents realloc in fileName() below
res.reserve(base.size() + 5);
bool begun = false;
for (int i = 0; i != base.size(); ++i) {
QChar c = base.at(i);
uint u = c.unicode();
if (u >= 'A' && u <= 'Z')
u -= 'A' - 'a';
if ((u >= 'a' && u <= 'z') || (u >= '0' && u <= '9')) {
res += QLatin1Char(u);
begun = true;
}
else if (begun) {
res += QLatin1Char('-');
begun = false;
}
}
while (res.endsWith(QLatin1Char('-')))
res.chop(1);
return res;
}
QString PageGenerator::fileName(const Node *node)
{
if (!node->url().isEmpty())
return node->url();
QString name = fileBase(node);
name += QLatin1Char('.');
name += fileExtension(node);
return name;
}
QString PageGenerator::outFileName()
{
return QFileInfo(static_cast<QFile *>(out().device())->fileName()).fileName();
}
void PageGenerator::beginSubPage(const Location& location,
const QString& fileName)
{
QFile *outFile = new QFile(outputDir() + "/" + fileName);
if (!outFile->open(QFile::WriteOnly))
location.fatal(tr("Cannot open output file '%1'")
.arg(outFile->fileName()));
QTextStream *out = new QTextStream(outFile);
out->setCodec("ISO-8859-1");
outStreamStack.push(out);
}
void PageGenerator::endSubPage()
{
outStreamStack.top()->flush();
delete outStreamStack.top()->device();
delete outStreamStack.pop();
}
QTextStream &PageGenerator::out()
{
return *outStreamStack.top();
}
/*!
Recursive writing of html files from the root \a node.
*/
void PageGenerator::generateInnerNode(const InnerNode *node,
CodeMarker *marker)
{
if (!node->url().isNull())
return;
if (node->type() == Node::Fake) {
const FakeNode *fakeNode = static_cast<const FakeNode *>(node);
if (fakeNode->subType() == Node::ExternalPage)
return;
#ifdef QDOC_QML
if (fakeNode->subType() == Node::QmlPropertyGroup)
return;
#endif
}
if (node->parent() != 0) {
beginSubPage(node->location(), fileName(node));
if (node->type() == Node::Namespace || node->type() == Node::Class) {
generateClassLikeNode(node, marker);
}
else if (node->type() == Node::Fake) {
generateFakeNode(static_cast<const FakeNode *>(node), marker);
}
endSubPage();
}
NodeList::ConstIterator c = node->childNodes().begin();
while (c != node->childNodes().end()) {
if ((*c)->isInnerNode() && (*c)->access() != Node::Private)
generateInnerNode((const InnerNode *) *c, marker);
++c;
}
}
QT_END_NAMESPACE
|
