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
|
/****************************************************************************
**
** 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 "doxygenparser.h"
#include "abstractmetalang.h"
#include "reporthandler.h"
#include "typesystem.h"
#include <QtXmlPatterns/QXmlQuery>
#include <QtCore/QFile>
#include <QtCore/QDir>
namespace
{
QString getSectionKindAttr(const AbstractMetaFunction* func)
{
if (func->isSignal()) {
return QLatin1String("signal");
} else {
QString kind = func->isPublic() ? QLatin1String("public") : QLatin1String("protected");
if (func->isStatic())
kind += QLatin1String("-static");
else if (func->isSlot())
kind += QLatin1String("-slot");
return kind;
}
}
}
Documentation DoxygenParser::retrieveModuleDocumentation()
{
return retrieveModuleDocumentation(packageName());
}
void DoxygenParser::fillDocumentation(AbstractMetaClass* metaClass)
{
if (!metaClass)
return;
QString doxyFileSuffix;
if (metaClass->enclosingClass()) {
doxyFileSuffix += metaClass->enclosingClass()->name();
doxyFileSuffix += QLatin1String("_1_1"); // FIXME: Check why _1_1!!
}
doxyFileSuffix += metaClass->name();
doxyFileSuffix += QLatin1String(".xml");
const char* prefixes[] = { "class", "struct", "namespace" };
const int numPrefixes = sizeof(prefixes) / sizeof(const char*);
bool isProperty = false;
QString doxyFilePath;
for (int i = 0; i < numPrefixes; ++i) {
doxyFilePath = documentationDataDirectory() + QLatin1Char('/')
+ QLatin1String(prefixes[i]) + doxyFileSuffix;
if (QFile::exists(doxyFilePath))
break;
doxyFilePath.clear();
}
if (doxyFilePath.isEmpty()) {
qCWarning(lcShiboken).noquote().nospace()
<< "Can't find doxygen file for class " << metaClass->name() << ", tried: "
<< QDir::toNativeSeparators(documentationDataDirectory())
<< "/{struct|class|namespace}"<< doxyFileSuffix;
return;
}
QXmlQuery xquery;
xquery.setFocus(QUrl(doxyFilePath));
// Get class documentation
QString classDoc = getDocumentation(xquery, QLatin1String("/doxygen/compounddef/detaileddescription"),
metaClass->typeEntry()->docModifications());
if (classDoc.isEmpty()) {
qCWarning(lcShiboken).noquote().nospace()
<< "Can't find documentation for class \"" << metaClass->name() << "\".";
}
metaClass->setDocumentation(classDoc);
//Functions Documentation
AbstractMetaFunctionList funcs = metaClass->functionsInTargetLang();
foreach (AbstractMetaFunction *func, funcs) {
if (!func || func->isPrivate())
continue;
QString query = QLatin1String("/doxygen/compounddef/sectiondef");
// properties
if (func->isPropertyReader() || func->isPropertyWriter()
|| func->isPropertyResetter()) {
query += QLatin1String("[@kind=\"property\"]/memberdef/name[text()=\"")
+ func->propertySpec()->name() + QLatin1String("\"]");
isProperty = true;
} else { // normal methods
QString kind = getSectionKindAttr(func);
query += QLatin1String("[@kind=\"") + kind
+ QLatin1String("-func\"]/memberdef/name[text()=\"")
+ func->originalName() + QLatin1String("\"]");
if (func->arguments().isEmpty()) {
QString args = func->isConstant() ? QLatin1String("() const ") : QLatin1String("()");
query += QLatin1String("/../argsstring[text()=\"") + args + QLatin1String("\"]");
} else {
int i = 1;
foreach (AbstractMetaArgument* arg, func->arguments()) {
QString type;
if (!arg->type()->isPrimitive()) {
query += QLatin1String("/../param[") + QString::number(i)
+ QLatin1String("]/type/ref[text()=\"")
+ arg->type()->name() + QLatin1String("\"]/../..");
} else {
query += QLatin1String("/../param[") + QString::number(i)
+ QLatin1String("]/type[text()=\"")
+ arg->type()->name() + QLatin1String("\"]/..");
}
++i;
}
}
}
if (!isProperty) {
query += QLatin1String("/../detaileddescription");
} else {
query = QLatin1Char('(') + query;
query += QLatin1String("/../detaileddescription)[1]");
}
QString doc = getDocumentation(xquery, query, DocModificationList());
func->setDocumentation(doc);
isProperty = false;
}
//Fields
AbstractMetaFieldList fields = metaClass->fields();
foreach (AbstractMetaField *field, fields) {
if (field->isPrivate())
return;
QString query = QLatin1String("/doxygen/compounddef/sectiondef/memberdef/name[text()=\"")
+ field->name() + QLatin1String("\"]/../detaileddescription");
QString doc = getDocumentation(xquery, query, DocModificationList());
field->setDocumentation(doc);
}
//Enums
AbstractMetaEnumList enums = metaClass->enums();
foreach (AbstractMetaEnum *meta_enum, enums) {
QString query = QLatin1String("/doxygen/compounddef/sectiondef/memberdef[@kind=\"enum\"]/name[text()=\"")
+ meta_enum->name() + QLatin1String("\"]/..");
QString doc = getDocumentation(xquery, query, DocModificationList());
meta_enum->setDocumentation(doc);
}
}
Documentation DoxygenParser::retrieveModuleDocumentation(const QString& name){
QString sourceFile = documentationDataDirectory() + QLatin1String("/indexpage.xml");
if (!QFile::exists(sourceFile)) {
qCWarning(lcShiboken).noquote().nospace()
<< "Can't find doxygen XML file for module " << name << ", tried: "
<< QDir::toNativeSeparators(sourceFile);
return Documentation();
}
QXmlQuery xquery;
xquery.setFocus(QUrl(sourceFile));
// Module documentation
QString query = QLatin1String("/doxygen/compounddef/detaileddescription");
return Documentation(getDocumentation(xquery, query, DocModificationList()));
}
|
