1 files changed, 116 insertions, 28 deletions

diff --git a/sources/shiboken6/ApiExtractor/docparser.cpp b/sources/shiboken6/ApiExtractor/docparser.cpp
index ea3828a43..468fe1098 100644
--- a/sources/shiboken6/ApiExtractor/docparser.cpp
+++ b/sources/shiboken6/ApiExtractor/docparser.cpp
@@ -1,15 +1,17 @@
 // Copyright (C) 2016 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
 #include "docparser.h"
-#include "classdocumentation.h"
+#include "abstractmetaargument.h"
 #include "abstractmetaenum.h"
-#include "abstractmetafield.h"
 #include "abstractmetafunction.h"
 #include "abstractmetalang.h"
+#include "abstractmetatype.h"
 #include "messages.h"
 #include "modifications.h"
 #include "reporthandler.h"
-#include "typesystem.h"
+#include "enumtypeentry.h"
+#include "complextypeentry.h"
 #include "xmlutils.h"
 
 #include <QtCore/QBuffer>
@@ -29,15 +31,37 @@
 
 using namespace Qt::StringLiterals;
 
-DocParser::DocParser()
+static inline bool isXpathDocModification(const DocModification &mod)
 {
-#ifdef HAVE_LIBXSLT
-    xmlSubstituteEntitiesDefault(1);
-#endif
+    return mod.mode() == TypeSystem::DocModificationXPathReplace;
+}
+
+static inline bool isNotXpathDocModification(const DocModification &mod)
+{
+    return mod.mode() != TypeSystem::DocModificationXPathReplace;
+}
+
+static void removeXpathDocModifications(DocModificationList *l)
+{
+    l->erase(std::remove_if(l->begin(), l->end(), isXpathDocModification), l->end());
+}
+
+static void removeNonXpathDocModifications(DocModificationList *l)
+{
+    l->erase(std::remove_if(l->begin(), l->end(), isNotXpathDocModification), l->end());
 }
 
+DocParser::DocParser() = default;
 DocParser::~DocParser() = default;
 
+void DocParser::fillGlobalFunctionDocumentation(const AbstractMetaFunctionPtr &)
+{
+}
+
+void DocParser::fillGlobalEnumDocumentation(AbstractMetaEnum &)
+{
+}
+
 QString DocParser::getDocumentation(const XQueryPtr &xquery, const QString& query,
                                     const DocModificationList& mods)
 {
@@ -84,22 +108,90 @@ bool DocParser::skipForQuery(const AbstractMetaFunctionCPtr &func)
                        usesRValueReference);
 }
 
-AbstractMetaFunctionCList DocParser::documentableFunctions(const AbstractMetaClass *metaClass)
+DocModificationList DocParser::getDocModifications(const AbstractMetaClassCPtr &cppClass)
+
+{
+    auto result = cppClass->typeEntry()->docModifications();
+    removeXpathDocModifications(&result);
+    return result;
+}
+
+static void filterBySignature(const AbstractMetaFunctionCPtr &func, DocModificationList *l)
 {
-    auto result = metaClass->functionsInTargetLang();
-    for (int i = result.size() - 1; i >= 0; --i)  {
-        if (DocParser::skipForQuery(result.at(i)) || result.at(i)->isUserAdded())
-            result.removeAt(i);
+    if (!l->isEmpty()) {
+        const QString minimalSignature = func->minimalSignature();
+        const auto filter = [&minimalSignature](const DocModification &mod) {
+            return mod.signature() != minimalSignature;
+        };
+        l->erase(std::remove_if(l->begin(), l->end(), filter), l->end());
+    }
+}
+
+DocModificationList DocParser::getDocModifications(const AbstractMetaFunctionCPtr &func,
+                                                   const AbstractMetaClassCPtr &cppClass)
+{
+    DocModificationList result;
+    if (func->isUserAdded()) {
+        result = func->addedFunctionDocModifications();
+        removeXpathDocModifications(&result);
+    } else if (cppClass != nullptr) {
+        result = cppClass->typeEntry()->functionDocModifications();
+        removeXpathDocModifications(&result);
+        filterBySignature(func, &result);
     }
     return result;
 }
 
-static inline bool isXpathDocModification(const DocModification &mod)
+DocModificationList DocParser::getXpathDocModifications(const AbstractMetaClassCPtr &cppClass)
 {
-    return mod.mode() == TypeSystem::DocModificationXPathReplace;
+    auto result = cppClass->typeEntry()->docModifications();
+    removeNonXpathDocModifications(&result);
+    return result;
 }
 
-QString DocParser::applyDocModifications(const DocModificationList& mods, const QString& xml)
+DocModificationList DocParser::getXpathDocModifications(const AbstractMetaFunctionCPtr &func,
+                                                        const AbstractMetaClassCPtr &cppClass)
+{
+    DocModificationList result;
+    if (func->isUserAdded()) {
+        result = func->addedFunctionDocModifications();
+        removeNonXpathDocModifications(&result);
+    } else if (cppClass != nullptr) {
+        result = cppClass->typeEntry()->functionDocModifications();
+        removeNonXpathDocModifications(&result);
+        filterBySignature(func, &result);
+    }
+    return result;
+}
+
+QString DocParser::enumBaseClass(const AbstractMetaEnum &e)
+{
+    switch (e.typeEntry()->pythonEnumType()) {
+    case TypeSystem::PythonEnumType::IntEnum:
+        return u"IntEnum"_s;
+    case TypeSystem::PythonEnumType::Flag:
+        return u"Flag"_s;
+    case TypeSystem::PythonEnumType::IntFlag:
+        return u"IntFlag"_s;
+    default:
+        break;
+    }
+    return e.typeEntry()->flags() != nullptr ? u"Flag"_s : u"Enum"_s;
+}
+
+AbstractMetaFunctionCList DocParser::documentableFunctions(const AbstractMetaClassCPtr &metaClass)
+{
+    auto result = metaClass->functionsInTargetLang();
+    for (auto i = result.size() - 1; i >= 0; --i)  {
+        if (DocParser::skipForQuery(result.at(i)) || result.at(i)->isUserAdded())
+            result.removeAt(i);
+    }
+    result.append(metaClass->cppSignalFunctions());
+    return result;
+}
+
+QString DocParser::applyDocModifications(const DocModificationList& xpathMods,
+                                         const QString& xml)
 {
     const char xslPrefix[] =
 R"(<xsl:template match="/">
@@ -113,32 +205,28 @@ R"(<xsl:template match="/">
 </xsl:template>
 )";
 
-    if (mods.isEmpty() || xml.isEmpty()
-        || !std::any_of(mods.cbegin(), mods.cend(), isXpathDocModification)) {
+    if (xpathMods.isEmpty() || xml.isEmpty())
         return xml;
-    }
 
     QString xsl = QLatin1StringView(xslPrefix);
-    for (const DocModification &mod : mods) {
-        if (isXpathDocModification(mod)) {
-            QString xpath = mod.xpath();
-            xpath.replace(u'"', u"&quot;"_s);
-            xsl += u"<xsl:template match=\""_s
-                   + xpath + u"\">"_s
-                   + mod.code() + u"</xsl:template>\n"_s;
-        }
+    for (const DocModification &mod : xpathMods) {
+        Q_ASSERT(isXpathDocModification(mod));
+        QString xpath = mod.xpath();
+        xpath.replace(u'"', u"&quot;"_s);
+        xsl += "<xsl:template match=\""_L1 + xpath + "\">"_L1
+               + mod.code() + "</xsl:template>\n"_L1;
     }
 
     QString errorMessage;
     const QString result = xsl_transform(xml, xsl, &errorMessage);
     if (!errorMessage.isEmpty())
         qCWarning(lcShibokenDoc, "%s",
-                  qPrintable(msgXpathDocModificationError(mods, errorMessage)));
+                  qPrintable(msgXpathDocModificationError(xpathMods, errorMessage)));
     if (result == xml) {
         const QString message = u"Query did not result in any modifications to \""_s
             + xml + u'"';
         qCWarning(lcShibokenDoc, "%s",
-                  qPrintable(msgXpathDocModificationError(mods, message)));
+                  qPrintable(msgXpathDocModificationError(xpathMods, message)));
     }
     return result;
 }