issue #11260 Inherited attribute is repeated twice in python

doxygen · doxygen · commit c91a8c85ebb0 · 2024-12-15T14:01:04.000+01:00
diff --git a/src/classdef.cpp b/src/classdef.cpp
@@ -403,6 +403,7 @@ class ClassDefImpl : public DefinitionMixin<ClassDefMutable>
     void writeTemplateSpec(OutputList &ol,const Definition *d,
             const QCString &type,SrcLangExt lang) const;
     void mergeMembersFromBaseClasses(bool mergeVirtualBaseClass);
+    void hideDerivedVariablesInPython(ClassDefMutable *cls);
 
     // PIMPL idiom
     class IMPL;
@@ -3739,7 +3740,7 @@ void ClassDefImpl::mergeMembersFromBaseClasses(bool mergeVirtualBaseClass)
                   found=matchArguments2(
                       srcMd->getOuterScope(),srcMd->getFileDef(),&srcAl,
                       dstMd->getOuterScope(),dstMd->getFileDef(),&dstAl,
-                      TRUE,getLanguage()
+                      TRUE,lang
                       );
                   //printf("      Yes, matching (%s<->%s): %d\n",
                   //    qPrint(argListToString(srcMd->argumentList())),
@@ -3805,7 +3806,8 @@ void ClassDefImpl::mergeMembersFromBaseClasses(bool mergeVirtualBaseClass)
             //       it seems that the member is not reachable by prefixing a
             //       scope name either (according to my compiler). Currently,
             //       this case is shown anyway.
-            if (!found && srcMd->protection()!=Protection::Private && !srcMd->isFriend() && srcMi->virtualBaseClass()==mergeVirtualBaseClass)
+            if (!found && srcMd->protection()!=Protection::Private && !srcMd->isFriend() &&
+                srcMi->virtualBaseClass()==mergeVirtualBaseClass && lang!=SrcLangExt::Python)
             {
               Protection prot = srcMd->protection();
               if (bcd.prot==Protection::Protected && prot==Protection::Public)
@@ -3830,7 +3832,7 @@ void ClassDefImpl::mergeMembersFromBaseClasses(bool mergeVirtualBaseClass)
               if (virt==Specifier::Normal && bcd.virt!=Specifier::Normal) virt=bcd.virt;
               bool virtualBaseClass = bcd.virt!=Specifier::Normal;
 
-              std::unique_ptr<MemberInfo> newMi = std::make_unique<MemberInfo>(srcMd,prot,virt,TRUE,virtualBaseClass);
+              auto newMi = std::make_unique<MemberInfo>(srcMd,prot,virt,TRUE,virtualBaseClass);
               newMi->setScopePath(bClass->name()+sep+srcMi->scopePath());
               if (ambiguous)
               {
@@ -3919,6 +3921,56 @@ void ClassDefImpl::mergeMembersFromBaseClasses(bool mergeVirtualBaseClass)
   }
 }
 
+// See issue11260, referring to a variable in a base class will make doxygen
+// add it as a member to the derived class, but this is not correct for non-private variables
+// so we correct this here, now we know the inheritance hierarchy
+void ClassDefImpl::hideDerivedVariablesInPython(ClassDefMutable *bClass)
+{
+  //printf("hideDerivedVariableInPython()\n");
+  if (bClass)
+  {
+    const MemberNameInfoLinkedMap &srcMnd  = bClass->memberNameInfoLinkedMap();
+    MemberNameInfoLinkedMap &dstMnd        = m_impl->allMemberNameInfoLinkedMap;
+
+    // recurse up the inheritance hierarchy
+    for (const auto &bcd : bClass->baseClasses())
+    {
+      hideDerivedVariablesInPython(toClassDefMutable(bcd.classDef));
+    }
+
+    for (auto &srcMni : srcMnd) // for each member in a base class
+    {
+      //printf("  candidate(%s)\n",qPrint(srcMni->memberName()));
+      MemberNameInfo *dstMni=dstMnd.find(srcMni->memberName());
+      if (dstMni) // that is also in this class
+      {
+        MemberNameInfo::iterator it;
+        //printf("%s member in %s and %s\n",qPrint(name()),qPrint(bClass->name()),qPrint(name()));
+        for (it=dstMni->begin();it!=dstMni->end();)
+        {
+          MemberDefMutable *dstMd = toMemberDefMutable((*it)->memberDef());
+          if (dstMd && dstMd->isVariable() && !dstMd->name().startsWith("__"))
+          {
+            //printf("  hiding member %s\n",qPrint(dstMd->name()));
+            // hide a member variable if it is already defined in a base class, unless
+            // it is a __private variable
+            removeMemberFromLists(dstMd);
+            it = dstMni->erase(it);
+          }
+          else
+          {
+            ++it;
+          }
+        }
+        if (dstMni->empty()) // if the list has become empty, remove the entry from the dictionary
+        {
+          dstMnd.del(srcMni->memberName());
+        }
+      }
+    }
+  }
+}
+
 /*!
  * recursively merges the 'all members' lists of a class base
  * with that of this class. Must only be called for classes without
@@ -3927,7 +3979,14 @@ void ClassDefImpl::mergeMembersFromBaseClasses(bool mergeVirtualBaseClass)
 void ClassDefImpl::mergeMembers()
 {
   if (m_impl->membersMerged) return;
-  if (getLanguage()==SrcLangExt::Python) return; // python does not have member overloading, see issue 8480
+  if (getLanguage()==SrcLangExt::Python)
+  {
+    for (const auto &bcd : baseClasses())
+    {
+      ClassDefMutable *bClass=toClassDefMutable(bcd.classDef);
+      hideDerivedVariablesInPython(bClass);
+    }
+  }
 
   //printf("> %s::mergeMembers()\n",qPrint(name()));
 
@@ -4519,20 +4578,20 @@ void ClassDefImpl::sortMemberLists()
 int ClassDefImpl::countMemberDeclarations(MemberListType lt,const ClassDef *inheritedFrom,
                                       MemberListType lt2,bool invert,bool showAlways,ClassDefSet &visitedClasses) const
 {
-  //printf("%s: countMemberDeclarations for %d and %d\n",qPrint(name()),lt.to_int(),lt2.to_int());
+  //printf("%s: countMemberDeclarations for %s and %s\n",qPrint(name()),lt.to_string(),lt2.to_string());
   int count=0;
   MemberList * ml  = getMemberList(lt);
   MemberList * ml2 = getMemberList(lt2);
   if (getLanguage()!=SrcLangExt::VHDL) // use specific declarations function
   {
     if (ml)
     {
-      count+=ml->numDecMembers();
+      count+=ml->numDecMembers(inheritedFrom);
       //printf("-> ml=%d\n",ml->numDecMembers());
     }
     if (ml2)
     {
-      count+=ml2->numDecMembers();
+      count+=ml2->numDecMembers(inheritedFrom);
       //printf("-> ml2=%d\n",ml2->numDecMembers());
     }
     // also include grouped members that have their own section in the class (see bug 722759)
@@ -4601,8 +4660,8 @@ int ClassDefImpl::countInheritedDecMembers(MemberListType lt,
   int inhCount = 0;
   int count = countMembersIncludingGrouped(lt,inheritedFrom,FALSE);
   bool process = count>0;
-  //printf("%s: countInheritedDecMembers: lt=%d process=%d count=%d invert=%d\n",
-  //    qPrint(name()),lt.to_int(),process,count,invert);
+  //printf("%s: countInheritedDecMembers: lt=%s process=%d count=%d invert=%d\n",
+  //    qPrint(name()),lt.to_string(),process,count,invert);
   if ((process^invert) || showAlways)
   {
     for (const auto &ibcd : m_impl->inherits)
@@ -4613,8 +4672,8 @@ int ClassDefImpl::countInheritedDecMembers(MemberListType lt,
       if (icd && icd->isLinkable())
       {
         convertProtectionLevel(lt,ibcd.prot,&lt1,&lt2);
-        //printf("%s: convert %d->(%d,%d) prot=%d\n",
-        //    qPrint(icd->name()),lt.to_int(),lt1.to_int(),lt2.to_int(),ibcd.prot);
+        //printf("%s: convert %s->(%s,%s) prot=%d\n",
+        //    qPrint(icd->name()),lt.to_string(),lt1.to_string(),lt2.to_string(),ibcd.prot);
         if (visitedClasses.find(icd)==visitedClasses.end())
         {
           visitedClasses.insert(icd); // guard for multiple virtual inheritance
@@ -4626,6 +4685,7 @@ int ClassDefImpl::countInheritedDecMembers(MemberListType lt,
       }
     }
   }
+  //printf("%s: count=%d\n",qPrint(name()),inhCount);
   return inhCount;
 }
 
@@ -4706,7 +4766,7 @@ int ClassDefImpl::countMembersIncludingGrouped(MemberListType lt,
     }
   }
   //printf("%s:countMembersIncludingGrouped(lt=%s,%s)=%d\n",
-  //    qPrint(name()),qPrint(lt.to_string()),ml?qPrint(ml->listType().toLabel()):"<none>",count);
+  //    qPrint(name()),qPrint(lt.to_string()),ml?qPrint(ml->listType().to_string()):"<none>",count);
   return count;
 }
 
@@ -4777,18 +4837,18 @@ void ClassDefImpl::writeMemberDeclarations(OutputList &ol,ClassDefSet &visitedCl
   }
   else
   {
-    //printf("%s::writeMemberDeclarations(%s) ml=%p ml2=%p\n",qPrint(name()),qPrint(title),ml,ml2);
+    //printf("%s::writeMemberDeclarations(%s) ml=%p ml2=%p\n",qPrint(name()),qPrint(title),(void*)ml,(void*)ml2);
     QCString tt = title, st = subTitle;
     if (ml)
     {
-      //printf("  writeDeclarations type=%s count=%d\n",qPrint(lt.to_string()),ml->numDecMembers());
+      //printf("  writeDeclarations ml type=%s count=%d\n",qPrint(lt.to_string()),ml->numDecMembers(inheritedFrom));
       ml->writeDeclarations(ol,this,nullptr,nullptr,nullptr,nullptr,tt,st,FALSE,showInline,inheritedFrom,lt,true);
       tt.clear();
       st.clear();
     }
     if (ml2)
     {
-      //printf("  writeDeclarations type=%s count=%d\n",qPrint(lt2.to_string()),ml2->numDecMembers());
+      //printf("  writeDeclarations ml2 type=%s count=%d\n",qPrint(lt2.to_string()),ml2->numDecMembers(inheritedFrom));
       ml2->writeDeclarations(ol,this,nullptr,nullptr,nullptr,nullptr,tt,st,FALSE,showInline,inheritedFrom,lt,ml==nullptr);
     }
     bool inlineInheritedMembers = Config_getBool(INLINE_INHERITED_MEMB);
diff --git a/src/doxygen.cpp b/src/doxygen.cpp
@@ -8304,12 +8304,14 @@ static void computeMemberRelationsForBaseClass(const ClassDef *cd,const BaseClas
               MemberDefMutable *bmd = toMemberDefMutable(ibmd->memberDef());
               if (bmd) // not part of an inline namespace
               {
-                if (bmd->virtualness()!=Specifier::Normal     ||
-                    bmd->getLanguage()==SrcLangExt::Python     ||
-                    bmd->getLanguage()==SrcLangExt::Java       ||
-                    bmd->getLanguage()==SrcLangExt::PHP        ||
-                    mbcd->compoundType()==ClassDef::Interface ||
-                    mbcd->compoundType()==ClassDef::Protocol)
+                auto lang     = bmd->getLanguage();
+                auto compType = mbcd->compoundType();
+                if (bmd->virtualness()!=Specifier::Normal ||
+                    lang==SrcLangExt::Python              ||
+                    lang==SrcLangExt::Java                ||
+                    lang==SrcLangExt::PHP                 ||
+                    compType==ClassDef::Interface         ||
+                    compType==ClassDef::Protocol)
                 {
                   const ArgumentList &bmdAl = bmd->argumentList();
                   const ArgumentList &mdAl =  md->argumentList();
@@ -8318,13 +8320,14 @@ static void computeMemberRelationsForBaseClass(const ClassDef *cd,const BaseClas
                   //        qPrint(argListToString(mdAl))
                   //      );
                   if (
-                      bmd->getLanguage()==SrcLangExt::Python ||
+                      lang==SrcLangExt::Python ||
                       matchArguments2(bmd->getOuterScope(),bmd->getFileDef(),&bmdAl,
                         md->getOuterScope(), md->getFileDef(), &mdAl,
-                        TRUE,bmd->getLanguage()
+                        TRUE,lang
                         )
                      )
                   {
+                    if (lang==SrcLangExt::Python && md->name().startsWith("__")) continue; // private members do not reimplement
                     //printf("match!\n");
                     const MemberDef *rmd = md->reimplements();
                     if (rmd==nullptr) // not already assigned
diff --git a/src/memberlist.cpp b/src/memberlist.cpp
@@ -119,62 +119,51 @@ int MemberList::countInheritableMembers(const ClassDef *inheritedFrom) const
 /*! Count the number of members in this list that are visible in
  *  the declaration part of a compound's documentation page.
  */
-void MemberList::countDecMembers()
+std::pair<int,int> MemberList::countDecMembers(const ClassDef *inheritedFrom) const
 {
-  if (m_numDecMembers!=-1) return;
-
   //printf("----- countDecMembers count=%d ----\n",count());
-  /*
-  m_varCnt=m_funcCnt=m_enumCnt=m_enumValCnt=0;
-  m_typeCnt=m_seqCnt=m_dictCnt=m_protoCnt=m_defCnt=m_friendCnt=0;
-  */
-  m_numDecMembers=0;
+  int numDecMembers=0;
+  int numDecEnumValues=0;
   for (const auto &md : m_members)
   {
     //printf("MemberList::countDecMembers(md=%s,%d)\n",qPrint(md->name()),md->isBriefSectionVisible());
-    if (md->isBriefSectionVisible())
+    if ((inheritedFrom==nullptr || !md->isReimplementedBy(inheritedFrom)) &&
+        md->isBriefSectionVisible())
     {
       switch(md->memberType())
       {
         case MemberType::Variable:    // fall through
         case MemberType::Event:       // fall through
-        case MemberType::Property:    /*m_varCnt++,*/
-                                     m_numDecMembers++;
+        case MemberType::Property:   numDecMembers++;
                                      break;
 // apparently necessary to get this to show up in declarations section?
         case MemberType::Interface:   // fall through
         case MemberType::Service:     // fall through
         case MemberType::Function:    // fall through
         case MemberType::Signal:      // fall through
         case MemberType::DCOP:        // fall through
-        case MemberType::Slot:        if (!md->isRelated() || md->getClassDef())
-                                       /*m_funcCnt++,*/
-                                       m_numDecMembers++;
+        case MemberType::Slot:       if (!md->isRelated() || md->getClassDef())
+                                     numDecMembers++;
                                      break;
-        case MemberType::Enumeration: /*m_enumCnt++,*/
-                                     m_numDecMembers++;
+        case MemberType::Enumeration:
+                                     numDecMembers++;
                                      break;
-        case MemberType::EnumValue:   m_numDecEnumValues++;
-                                     m_numDecMembers++;
+        case MemberType::EnumValue:  numDecEnumValues++;
+                                     numDecMembers++;
                                      break;
-        case MemberType::Typedef:     /*m_typeCnt++,*/
-                                     m_numDecMembers++;
+        case MemberType::Typedef:    numDecMembers++;
                                      break;
-        case MemberType::Sequence:    /*m_seqCnt++,*/
-                                     m_numDecMembers++;
+        case MemberType::Sequence:   numDecMembers++;
                                      break;
-        case MemberType::Dictionary:  /*m_dictCnt++,*/
-                                     m_numDecMembers++;
+        case MemberType::Dictionary: numDecMembers++;
                                      break;
-        //case MemberType::Prototype:   m_protoCnt++,m_numDecMembers++; break;
         case MemberType::Define:      if (Config_getBool(EXTRACT_ALL) ||
                                          !md->argsString().isEmpty() ||
                                          !md->initializer().isEmpty() ||
                                          md->hasDocumentation()
-                                        ) /*m_defCnt++,*/ m_numDecMembers++;
+                                        ) numDecMembers++;
                                      break;
-        case MemberType::Friend:      /*m_friendCnt++,*/
-                                     m_numDecMembers++;
+        case MemberType::Friend:     numDecMembers++;
                                      break;
         default:
           err("Unknown member type found for member '%s'!\n",qPrint(md->name()));
@@ -184,24 +173,18 @@ void MemberList::countDecMembers()
   for (const auto &mg : m_memberGroupRefList)
   {
     mg->countDecMembers();
-    /*
-    m_varCnt+=mg->varCount();
-    m_funcCnt+=mg->funcCount();
-    m_enumCnt+=mg->enumCount();
-    m_enumValCnt+=mg->enumValueCount();
-    m_typeCnt+=mg->typedefCount();
-    m_seqCnt+=mg->sequenceCount();
-    m_dictCnt+=mg->dictionaryCount();
-    m_protoCnt+=mg->protoCount();
-    m_defCnt+=mg->defineCount();
-    m_friendCnt+=mg->friendCount();
-    */
-    m_numDecMembers+=mg->numDecMembers();
-    m_numDecEnumValues+=mg->numDecEnumValues();
+    numDecMembers+=mg->numDecMembers();
+    numDecEnumValues+=mg->numDecEnumValues();
   }
   //printf("----- end countDecMembers ----\n");
 
-  //printf("MemberList::countDecMembers()=%d\n",m_numDecMembers);
+  return std::make_pair(numDecMembers,numDecEnumValues);
+}
+
+void MemberList::countDecMembers() const
+{
+  if (m_numDecMembers!=-1) return; // already cached
+  std::tie(m_numDecMembers, m_numDecEnumValues) = countDecMembers(nullptr); // cache new values
 }
 
 void MemberList::countDocMembers()
@@ -528,9 +511,9 @@ void MemberList::writeDeclarations(OutputList &ol,
   //printf("%p: MemberList::writeDeclaration(title='%s',subtitle='%s')=%d inheritedFrom=%p\n",
   //       (void*)this,qPrint(title),qPrint(subtitle),numDecMembers(),(void*)inheritedFrom);
 
-  int num = numDecMembers();
+  int num = numDecMembers(inheritedFrom);
   int numEnumValues = numDecEnumValues();
-  if (inheritedFrom)
+  if (inheritedFrom && num>0)
   {
     if (cd && !optimizeVhdl)
     {
diff --git a/src/memberlist.h b/src/memberlist.h
@@ -18,6 +18,7 @@
 
 #include <vector>
 #include <algorithm>
+#include <utility>
 
 #include "memberdef.h"
 #include "linkedmap.h"
@@ -113,12 +114,16 @@ class MemberList : public MemberVector
     MemberListType listType() const { return m_listType; }
     MemberListContainer container() const { return m_container; }
 
-    int numDecMembers() const    { ASSERT(m_numDecMembers!=-1); return m_numDecMembers; }
+    int numDecMembers(const ClassDef *inheritedFrom) const
+    { return countDecMembers(inheritedFrom).first; }
+    int numDecMembers() const
+    { ASSERT(m_numDecMembers!=-1); return m_numDecMembers; }
     int numDecEnumValues() const { return m_numDecEnumValues; }
     int numDocMembers() const    { ASSERT(m_numDocMembers!=-1); return m_numDocMembers; }
     int numDocEnumValues() const { return m_numDocEnumValues; }
     bool needsSorting() const    { return m_needsSorting; }
-    void countDecMembers();
+    void countDecMembers() const;
+    std::pair<int,int> countDecMembers(const ClassDef *inheritedFrom) const;
     void countDocMembers();
     int countInheritableMembers(const ClassDef *inheritedFrom) const;
     void writePlainDeclarations(OutputList &ol,bool inGroup,
@@ -147,8 +152,8 @@ class MemberList : public MemberVector
 
   private:
     int countEnumValues(const MemberDef *md) const;
-    int m_numDecMembers; // number of members in the brief part of the memberlist
-    int m_numDecEnumValues;
+    mutable int m_numDecMembers; // number of members in the brief part of the memberlist
+    mutable int m_numDecEnumValues;
     int m_numDocMembers; // number of members in the detailed part of the memberlist
     int m_numDocEnumValues;
     MemberGroupRefList m_memberGroupRefList;
diff --git a/src/membername.h b/src/membername.h
diff --git a/src/pyscanner.l b/src/pyscanner.l
