aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/ApiExtractor/qtdocparser.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken2/ApiExtractor/qtdocparser.cpp')
-rw-r--r--sources/shiboken2/ApiExtractor/qtdocparser.cpp160
1 files changed, 99 insertions, 61 deletions
diff --git a/sources/shiboken2/ApiExtractor/qtdocparser.cpp b/sources/shiboken2/ApiExtractor/qtdocparser.cpp
index f1421ff91..0ac87bd16 100644
--- a/sources/shiboken2/ApiExtractor/qtdocparser.cpp
+++ b/sources/shiboken2/ApiExtractor/qtdocparser.cpp
@@ -34,6 +34,7 @@
#include <QtXmlPatterns/QXmlQuery>
#include <QtCore/QDir>
#include <QtCore/QFile>
+#include <QtCore/QTextStream>
#include <QUrl>
Documentation QtDocParser::retrieveModuleDocumentation()
@@ -41,12 +42,50 @@ Documentation QtDocParser::retrieveModuleDocumentation()
return retrieveModuleDocumentation(packageName());
}
+static void formatFunctionArgTypeQuery(QTextStream &str, const AbstractMetaArgument *arg)
+{
+ const AbstractMetaType *metaType = arg->type();
+ if (metaType->isConstant())
+ str << "const " ;
+ switch (metaType->typeUsagePattern()) {
+ case AbstractMetaType::PrimitivePattern:
+ str << metaType->name();
+ break;
+ case AbstractMetaType::FlagsPattern: {
+ // Modify qualified name "QFlags<Qt::AlignmentFlag>" with name "Alignment"
+ // to "Qt::Alignment" as seen by qdoc.
+ const FlagsTypeEntry *flagsEntry = static_cast<const FlagsTypeEntry *>(metaType->typeEntry());
+ QString name = flagsEntry->qualifiedCppName();
+ if (name.endsWith(QLatin1Char('>')) && name.startsWith(QLatin1String("QFlags<"))) {
+ const int lastColon = name.lastIndexOf(QLatin1Char(':'));
+ if (lastColon != -1) {
+ name.replace(lastColon + 1, name.size() - lastColon - 1, metaType->name());
+ name.remove(0, 7);
+ } else {
+ name = metaType->name(); // QFlags<> of enum in global namespace
+ }
+ }
+ str << name;
+ }
+ break;
+ default: // Fully qualify enums (Qt::AlignmentFlag), nested classes, etc.
+ str << metaType->typeEntry()->qualifiedCppName();
+ break;
+ }
+
+ if (metaType->referenceType() == LValueReference)
+ str << " &";
+ else if (metaType->referenceType() == RValueReference)
+ str << " &&";
+ else if (metaType->indirections())
+ str << ' ' << QByteArray(metaType->indirections(), '*');
+}
+
void QtDocParser::fillDocumentation(AbstractMetaClass* metaClass)
{
if (!metaClass)
return;
- QString scope = metaClass->name();
const AbstractMetaClass* context = metaClass->enclosingClass();
while(context) {
if (context->enclosingClass() == 0)
@@ -54,32 +93,35 @@ void QtDocParser::fillDocumentation(AbstractMetaClass* metaClass)
context = context->enclosingClass();
}
- QString filename = metaClass->qualifiedCppName().toLower();
- filename.replace(QLatin1String("::"), QLatin1String("-"));
- QString sourceFile = documentationDataDirectory() + QLatin1Char('/')
- + filename + QLatin1String(".xml");
- if (metaClass->enclosingClass())
- sourceFile.replace(QLatin1String("::"), QLatin1String("-"));
+ QString sourceFileRoot = documentationDataDirectory() + QLatin1Char('/')
+ + metaClass->qualifiedCppName().toLower();
+ sourceFileRoot.replace(QLatin1String("::"), QLatin1String("-"));
- if (!QFile::exists(sourceFile)) {
+ 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);
+ << "Can't find qdoc file for class " << metaClass->name() << ", tried: "
+ << QDir::toNativeSeparators(sourceFile.absoluteFilePath());
return;
}
QXmlQuery xquery;
- xquery.setFocus(QUrl(sourceFile));
+ const QString sourceFileName = sourceFile.absoluteFilePath();
+ xquery.setFocus(QUrl::fromLocalFile(sourceFileName));
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");
+ const QString classQuery = QLatin1String("/WebXML/document/")
+ + (metaClass->isNamespace() ? QLatin1String("namespace") : QLatin1String("class"))
+ + QLatin1String("[@name=\"") + className + QLatin1String("\"]");
+ QString query = classQuery + QLatin1String("/description");
DocModificationList signedModifs, classModifs;
- foreach (DocModification docModif, metaClass->typeEntry()->docModifications()) {
+ const DocModificationList &mods = metaClass->typeEntry()->docModifications();
+ for (const DocModification &docModif : mods) {
if (docModif.signature().isEmpty())
classModifs.append(docModif);
else
@@ -87,62 +129,49 @@ void QtDocParser::fillDocumentation(AbstractMetaClass* metaClass)
}
Documentation doc(getDocumentation(xquery, query, classModifs));
+ if (doc.isEmpty())
+ qCWarning(lcShiboken(), "%s", qPrintable(msgCannotFindDocumentation(sourceFileName, "class", className, query)));
metaClass->setDocumentation(doc);
//Functions Documentation
- AbstractMetaFunctionList funcs = metaClass->functionsInTargetLang();
- foreach (AbstractMetaFunction *func, funcs) {
- if (!func || func->isPrivate())
- continue;
-
- QString query = QLatin1String("/WebXML/document/") + type
- + QLatin1String("[@name=\"") + className + QLatin1String("\"]");
+ const AbstractMetaFunctionList &funcs = DocParser::documentableFunctions(metaClass);
+ for (AbstractMetaFunction *func : funcs) {
+ query.clear();
+ QTextStream str(&query);
+ str << classQuery;
// properties
if (func->isPropertyReader() || func->isPropertyWriter() || func->isPropertyResetter()) {
- query += QLatin1String("/property[@name=\"") + func->propertySpec()->name()
- + QLatin1String("\"]");
+ str << "/property[@name=\"" << func->propertySpec()->name() << "\"]";
} 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("\"]");
-
- int i = 1;
- foreach (AbstractMetaArgument* arg, func->arguments()) {
- 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)
- + QLatin1String("][@left=\"") + type + QLatin1String("\"]/..");
- ++i;
+ str << "/function[@name=\"" << func->originalName() << "\" and count(parameter)="
+ << func->arguments().count() << " and @const=\""
+ << (func->isConstant() ? "true" : "false") << "\"]";
+
+ const AbstractMetaArgumentList &arguments = func->arguments();
+ for (int i = 0, size = arguments.size(); i < size; ++i) {
+ str << "/parameter[" << (i + 1) << "][@type=\"";
+ formatFunctionArgTypeQuery(str, arguments.at(i));
+ str << "\"]/..";
}
}
- query += QLatin1String("/description");
+ str << "/description";
DocModificationList funcModifs;
- foreach (DocModification funcModif, signedModifs) {
+ for (const DocModification &funcModif : qAsConst(signedModifs)) {
if (funcModif.signature() == func->minimalSignature())
funcModifs.append(funcModif);
}
doc.setValue(getDocumentation(xquery, query, funcModifs));
+ if (doc.isEmpty()) {
+ qCWarning(lcShiboken(), "%s",
+ qPrintable(msgCannotFindDocumentation(sourceFileName, metaClass, func, query)));
+ }
func->setDocumentation(doc);
}
#if 0
// Fields
- AbstractMetaFieldList fields = metaClass->fields();
- foreach (AbstractMetaField *field, fields) {
+ const AbstractMetaFieldList &fields = metaClass->fields();
+ for (AbstractMetaField *field : fields) {
if (field->isPrivate())
return;
@@ -152,13 +181,16 @@ void QtDocParser::fillDocumentation(AbstractMetaClass* metaClass)
}
#endif
// Enums
- AbstractMetaEnumList enums = metaClass->enums();
- foreach (AbstractMetaEnum *meta_enum, enums) {
- QString query = QLatin1String("/WebXML/document/") + type
- + QLatin1String("[@name=\"")
- + className + QLatin1String("\"]/enum[@name=\"")
- + meta_enum->name() + QLatin1String("\"]/description");
+ const AbstractMetaEnumList &enums = metaClass->enums();
+ for (AbstractMetaEnum *meta_enum : enums) {
+ query.clear();
+ QTextStream(&query) << classQuery << "/enum[@name=\""
+ << meta_enum->name() << "\"]/description";
doc.setValue(getDocumentation(xquery, query, DocModificationList()));
+ if (doc.isEmpty()) {
+ qCWarning(lcShiboken(), "%s",
+ qPrintable(msgCannotFindDocumentation(sourceFileName, metaClass, meta_enum, query)));
+ }
meta_enum->setDocumentation(doc);
}
}
@@ -172,9 +204,12 @@ Documentation QtDocParser::retrieveModuleDocumentation(const QString& name)
QString sourceFile = documentationDataDirectory() + QLatin1Char('/')
+ moduleName.toLower() + QLatin1String(".xml");
+ if (!QFile::exists(sourceFile))
+ sourceFile = documentationDataDirectory() + QLatin1Char('/')
+ + moduleName.toLower() + QLatin1String("-module.webxml");
if (!QFile::exists(sourceFile)) {
qCWarning(lcShiboken).noquote().nospace()
- << "Can't find qdoc3 file for module " << name << ", tried: "
+ << "Can't find qdoc file for module " << name << ", tried: "
<< QDir::toNativeSeparators(sourceFile);
return Documentation();
}
@@ -184,5 +219,8 @@ Documentation QtDocParser::retrieveModuleDocumentation(const QString& name)
// Module documentation
QString query = QLatin1String("/WebXML/document/page[@name=\"") + moduleName + QLatin1String("\"]/description");
- return Documentation(getDocumentation(xquery, query, DocModificationList()));
+ const Documentation doc = getDocumentation(xquery, query, DocModificationList());
+ if (doc.isEmpty())
+ qCWarning(lcShiboken(), "%s", qPrintable(msgCannotFindDocumentation(sourceFile, "module", name, query)));
+ return doc;
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-10 23:53:25 +0000