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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of PySide2.
**
** $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$
**
****************************************************************************/
#include "qtdocparser.h"
#include "abstractmetalang.h"
#include "reporthandler.h"
#include "typesystem.h"
#include <QtXmlPatterns/QXmlQuery>
#include <QtCore/QDir>
#include <QtCore/QFile>
#include <QUrl>
Documentation QtDocParser::retrieveModuleDocumentation()
{
return retrieveModuleDocumentation(packageName());
}
void QtDocParser::fillDocumentation(AbstractMetaClass* metaClass)
{
if (!metaClass)
return;
QString scope = metaClass->name();
const AbstractMetaClass* context = metaClass->enclosingClass();
while(context) {
if (context->enclosingClass() == 0)
break;
context = context->enclosingClass();
}
QString sourceFileRoot = documentationDataDirectory() + QLatin1Char('/')
+ metaClass->qualifiedCppName().toLower();
sourceFileRoot.replace(QLatin1String("::"), QLatin1String("-"));
QFileInfo sourceFile(sourceFileRoot + QStringLiteral(".webxml"));
if (!sourceFile.exists())
sourceFile.setFile(sourceFileRoot + QStringLiteral(".xml"));
if (!sourceFile.exists()) {
qCWarning(lcShiboken).noquote().nospace()
<< "Can't find qdoc3 file for class " << metaClass->name() << ", tried: "
<< QDir::toNativeSeparators(sourceFile.absoluteFilePath());
return;
}
QXmlQuery xquery;
xquery.setFocus(QUrl::fromLocalFile(sourceFile.absoluteFilePath()));
QString className = metaClass->name();
// Class/Namespace documentation
QString type = metaClass->isNamespace() ? QLatin1String("namespace") : QLatin1String("class");
QString query = QLatin1String("/WebXML/document/") + type + QLatin1String("[@name=\"")
+ className + QLatin1String("\"]/description");
DocModificationList signedModifs, classModifs;
const DocModificationList &mods = metaClass->typeEntry()->docModifications();
for (const DocModification &docModif : mods) {
if (docModif.signature().isEmpty())
classModifs.append(docModif);
else
signedModifs.append(docModif);
}
Documentation doc(getDocumentation(xquery, query, classModifs));
metaClass->setDocumentation(doc);
//Functions Documentation
const AbstractMetaFunctionList &funcs = metaClass->functionsInTargetLang();
for (AbstractMetaFunction *func : funcs) {
if (!func || func->isPrivate())
continue;
QString query = QLatin1String("/WebXML/document/") + type
+ QLatin1String("[@name=\"") + className + QLatin1String("\"]");
// properties
if (func->isPropertyReader() || func->isPropertyWriter() || func->isPropertyResetter()) {
query += QLatin1String("/property[@name=\"") + func->propertySpec()->name()
+ QLatin1String("\"]");
} else { // normal methods
QString isConst = func->isConstant() ? QLatin1String("true") : QLatin1String("false");
query += QLatin1String("/function[@name=\"") + func->originalName()
+ QLatin1String("\" and count(parameter)=")
+ QString::number(func->arguments().count())
+ QLatin1String(" and @const=\"") + isConst + QLatin1String("\"]");
const AbstractMetaArgumentList &arguments = func->arguments();
for (int i = 0, size = arguments.size(); i < size; ++i) {
const AbstractMetaArgument *arg = arguments.at(i);
QString type = arg->type()->name();
if (arg->type()->isConstant())
type.prepend(QLatin1String("const "));
if (arg->type()->referenceType() == LValueReference) {
type += QLatin1String(" &");
} else if (arg->type()->referenceType() == RValueReference) {
type += QLatin1String(" &&");
} else if (arg->type()->indirections()) {
type += QLatin1Char(' ');
for (int j = 0, max = arg->type()->indirections(); j < max; ++j)
type += QLatin1Char('*');
}
query += QLatin1String("/parameter[") + QString::number(i + 1)
+ QLatin1String("][@left=\"") + type + QLatin1String("\"]/..");
}
}
query += QLatin1String("/description");
DocModificationList funcModifs;
for (const DocModification &funcModif : qAsConst(signedModifs)) {
if (funcModif.signature() == func->minimalSignature())
funcModifs.append(funcModif);
}
doc.setValue(getDocumentation(xquery, query, funcModifs));
func->setDocumentation(doc);
}
#if 0
// Fields
const AbstractMetaFieldList &fields = metaClass->fields();
for (AbstractMetaField *field : fields) {
if (field->isPrivate())
return;
QString query = "/doxygen/compounddef/sectiondef/memberdef/name[text()=\"" + field->name() + "\"]/..";
Documentation doc = getDocumentation(DocModificationList(), xquery, query);
field->setDocumentation(doc);
}
#endif
// Enums
const AbstractMetaEnumList &enums = metaClass->enums();
for (AbstractMetaEnum *meta_enum : enums) {
QString query = QLatin1String("/WebXML/document/") + type
+ QLatin1String("[@name=\"")
+ className + QLatin1String("\"]/enum[@name=\"")
+ meta_enum->name() + QLatin1String("\"]/description");
doc.setValue(getDocumentation(xquery, query, DocModificationList()));
meta_enum->setDocumentation(doc);
}
}
Documentation QtDocParser::retrieveModuleDocumentation(const QString& name)
{
// TODO: This method of acquiring the module name supposes that the target language uses
// dots as module separators in package names. Improve this.
QString moduleName = name;
moduleName.remove(0, name.lastIndexOf(QLatin1Char('.')) + 1);
QString sourceFile = documentationDataDirectory() + QLatin1Char('/')
+ moduleName.toLower() + QLatin1String(".xml");
if (!QFile::exists(sourceFile)) {
qCWarning(lcShiboken).noquote().nospace()
<< "Can't find qdoc3 file for module " << name << ", tried: "
<< QDir::toNativeSeparators(sourceFile);
return Documentation();
}
QXmlQuery xquery;
xquery.setFocus(QUrl(sourceFile));
// Module documentation
QString query = QLatin1String("/WebXML/document/page[@name=\"") + moduleName + QLatin1String("\"]/description");
return Documentation(getDocumentation(xquery, query, DocModificationList()));
}
|
