base-members

Author: K-ballo

src/lib/CorpusImpl.cpp

@@ -1004,13 +1004,6 @@ qualifiedName(
 void
 CorpusImpl::finalize()
 {
-    // Finalizing record interfaces
-    {
-        report::debug("  - Finalizing records");
-        RecordsFinalizer finalizer(*this);
-        finalizer.build();
-    }
-
     report::info("Finalizing corpus");
 
     {
@@ -1026,6 +1019,13 @@ CorpusImpl::finalize()
         finalizer.build();
     }
 
+    // Finalizing record interfaces
+    {
+        report::debug("  - Finalizing records");
+        RecordsFinalizer finalizer(*this);
+        finalizer.build();
+    }
+
     if (config->overloads)
     {
         report::debug("  - Finalizing overloads");

src/lib/Metadata/Finalizers/BaseMembersFinalizer.cpp

@@ -15,9 +15,19 @@
 
 namespace clang::mrdocs {
 
-void
-BaseMembersFinalizer::
-inheritBaseMembers(RecordInfo& I, RecordInfo const& B, AccessKind const A)
+namespace {
+bool
+shouldCopy(Config const& config, Info const& M)
+{
+    if (config->inheritBaseMembers == PublicSettings::BaseMemberInheritance::CopyDependencies)
+    {
+        return M.Extraction == ExtractionMode::Dependency;
+    }
+    return config->inheritBaseMembers == PublicSettings::BaseMemberInheritance::CopyAll;
+}
+
+AccessKind
+effectiveAccess(AccessKind const declaredAccess, AccessKind const A)
 {
     if (A == AccessKind::Public)
     {
@@ -26,71 +36,43 @@ inheritBaseMembers(RecordInfo& I, RecordInfo const& B, AccessKind const A)
         // members of the derived class and all protected members of the base
         // class are accessible as protected members of the derived class.
         // Private members of the base are never accessible unless friended.
-        inheritBaseMembers(I.id, I.Interface.Public, B.Interface.Public);
-        inheritBaseMembers(I.id, I.Interface.Protected, B.Interface.Protected);
+        return declaredAccess;
     }
     else if (A == AccessKind::Protected)
     {
         // When a class uses protected member access specifier to derive from a
         // base, all public and protected members of the base class are
         // accessible as protected members of the derived class (private members
         // of the base are never accessible unless friended).
-        inheritBaseMembers(I.id, I.Interface.Protected, B.Interface.Public);
-        inheritBaseMembers(I.id, I.Interface.Protected, B.Interface.Protected);
+        return AccessKind::Protected;
     }
-    else if (A == AccessKind::Private && corpus_.config->extractPrivate)
+    else if (A == AccessKind::Private)
     {
         // When a class uses private member access specifier to derive from a
         // base, all public and protected members of the base class are
         // accessible as private members of the derived class (private members
         // of the base are never accessible unless friended).
-        inheritBaseMembers(I.id, I.Interface.Private, B.Interface.Public);
-        inheritBaseMembers(I.id, I.Interface.Private, B.Interface.Protected);
+        return AccessKind::Private;
     }
-}
 
-void
-BaseMembersFinalizer::
-inheritBaseMembers(
-    SymbolID const& derivedId,
-    RecordTranche& derived,
-    RecordTranche const& base)
-{
-    inheritBaseMembers(derivedId, derived.NamespaceAliases, base.NamespaceAliases);
-    inheritBaseMembers(derivedId, derived.Typedefs, base.Typedefs);
-    inheritBaseMembers(derivedId, derived.Records, base.Records);
-    inheritBaseMembers(derivedId, derived.Enums, base.Enums);
-    inheritBaseMembers(derivedId, derived.Functions, base.Functions);
-    inheritBaseMembers(derivedId, derived.StaticFunctions, base.StaticFunctions);
-    inheritBaseMembers(derivedId, derived.Variables, base.Variables);
-    inheritBaseMembers(derivedId, derived.StaticVariables, base.StaticVariables);
-    inheritBaseMembers(derivedId, derived.Concepts, base.Concepts);
-    inheritBaseMembers(derivedId, derived.Guides, base.Guides);
-}
-
-namespace {
-bool
-shouldCopy(Config const& config, Info const& M)
-{
-    if (config->inheritBaseMembers == PublicSettings::BaseMemberInheritance::CopyDependencies)
-    {
-        return M.Extraction == ExtractionMode::Dependency;
-    }
-    return config->inheritBaseMembers == PublicSettings::BaseMemberInheritance::CopyAll;
+    return AccessKind::None;
 }
 }
 
-void
+void 
 BaseMembersFinalizer::
-inheritBaseMembers(
-    SymbolID const& derivedId,
-    std::vector<SymbolID>& derived,
-    std::vector<SymbolID> const& base)
+inheritBaseMembers(RecordInfo& I, RecordInfo const& B, AccessKind const A)
 {
-    for (SymbolID const& otherID: base)
+    SymbolID const& derivedId = I.id;
+    std::vector<MemberInfo>& derived = I.Members;
+    std::vector<MemberInfo> const& base = B.Members;
+
+    for (auto const& other: base)
     {
+        SymbolID const& otherID = other.id;
+
         // Find the info from the base class
-        MRDOCS_CHECK_OR_CONTINUE(!contains(derived, otherID));
+        MRDOCS_CHECK_OR_CONTINUE(!std::ranges::contains(derived, otherID, &MemberInfo::id));
         Info* otherInfoPtr = corpus_.find(otherID);
         MRDOCS_CHECK_OR_CONTINUE(otherInfoPtr);
         Info& otherInfo = *otherInfoPtr;
@@ -123,7 +105,7 @@ inheritBaseMembers(
                 // For other kinds of members, it's a shadow if the names
                 // are the same
                 return info.Name == otherInfo.Name;
-            });
+            }, &MemberInfo::id);
         MRDOCS_CHECK_OR_CONTINUE(shadowIt == derived.end());
 
         // Not a shadow, so inherit the base member
@@ -137,7 +119,7 @@ inheritBaseMembers(
             // extraction mode to be regular, but that is controversial.
             if (otherInfo.Extraction != ExtractionMode::Dependency)
             {
-                derived.push_back(otherID);
+                derived.emplace_back(effectiveAccess(other.EffectiveAccess, A), other.Kind, otherID);
             }
         }
         else
@@ -152,7 +134,7 @@ inheritBaseMembers(
             otherCopy->id = SymbolID::createFromString(
                 std::format("{}-{}", toBase16Str(otherCopy->Parent),
                             toBase16Str(otherInfo.id)));
-            derived.push_back(otherCopy->id);
+            derived.emplace_back(effectiveAccess(other.EffectiveAccess, A), other.Kind, otherCopy->id);
             // Get the extraction mode from the derived class
             if (otherCopy->Extraction == ExtractionMode::Dependency)
             {

src/lib/Metadata/Finalizers/BaseMembersFinalizer.hpp

@@ -32,18 +32,6 @@ class BaseMembersFinalizer
     void
     inheritBaseMembers(RecordInfo& I, RecordInfo const& B, AccessKind A);
 
-    void
-    inheritBaseMembers(
-        SymbolID const& derivedId,
-        RecordTranche& derived,
-        RecordTranche const& base);
-
-    void
-    inheritBaseMembers(
-        SymbolID const& derivedId,
-        std::vector<SymbolID>& derived,
-        std::vector<SymbolID> const& base);
-
     void
     finalizeRecords(std::vector<SymbolID> const& ids);
 

test-files/golden-tests/config/inherit-base-members/copy-dependencies.adoc

@@ -337,8 +337,6 @@ class derived
 | This function should be inherited by derived classes.
 | link:#base-do_base_shadowed[`do_base_shadowed`] 
 | This function should shadow the excluded_base function.
-| link:#base-do_derived_shadowed[`do_derived_shadowed`] 
-| This function should be shadowed by derived classes.
 | link:#derived-do_excluded_inherited[`do_excluded_inherited`] 
 | This function should be inherited by derived classes.
 | link:#derived-do_shadowed[`do_shadowed`] 
@@ -450,10 +448,36 @@ class private_derived
 |===
 | Name
 | Description
+| link:#base_base-base_base_inherited[`base_base_inherited`] 
+| This function should be indirectly inherited by derived classes.
+| link:#base-base_inherited[`base_inherited`] 
+| This function should be inherited by derived classes.
+| link:#base-base_shadowed[`base_shadowed`] 
+| This function should shadow the excluded_base function.
 | link:#private_derived-derived_shadowed[`derived_shadowed`] 
 | This function should shadow the base class function.
+| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] 
+| This function should be indirectly inherited by derived classes.
 | link:#private_derived-do_derived_shadowed[`do_derived_shadowed`] 
 | This function should shadow the base class function.
+| link:#private_derived-excluded_inherited[`excluded_inherited`] 
+| This function should be inherited by derived classes.
+|===
+
+=== Protected Member Functions
+
+[cols=2]
+|===
+| Name
+| Description
+| link:#base-do_base_inherited[`do_base_inherited`] 
+| This function should be inherited by derived classes.
+| link:#base-do_base_shadowed[`do_base_shadowed`] 
+| This function should shadow the excluded_base function.
+| link:#private_derived-do_excluded_inherited[`do_excluded_inherited`] 
+| This function should be inherited by derived classes.
+| link:#private_derived-do_shadowed[`do_shadowed`] 
+| This function should be shadowed by derived classes.
 |===
 
 [#private_derived-derived_shadowed]
@@ -494,6 +518,51 @@ do_derived_shadowed();
 
 A class that uses private inheritance only
 
+[#private_derived-excluded_inherited]
+== link:#private_derived[private_derived]::excluded_inherited
+
+This function should be inherited by derived classes.
+
+=== Synopsis
+
+Declared in `<copy‐dependencies.cpp>`
+
+[source,cpp,subs="verbatim,replacements,macros,-callouts"]
+----
+excluded_base&
+excluded_inherited();
+----
+
+[#private_derived-do_excluded_inherited]
+== link:#private_derived[private_derived]::do_excluded_inherited
+
+This function should be inherited by derived classes.
+
+=== Synopsis
+
+Declared in `<copy‐dependencies.cpp>`
+
+[source,cpp,subs="verbatim,replacements,macros,-callouts"]
+----
+excluded_base&
+do_excluded_inherited();
+----
+
+[#private_derived-do_shadowed]
+== link:#private_derived[private_derived]::do_shadowed
+
+This function should be shadowed by derived classes.
+
+=== Synopsis
+
+Declared in `<copy‐dependencies.cpp>`
+
+[source,cpp,subs="verbatim,replacements,macros,-callouts"]
+----
+excluded_base&
+do_shadowed();
+----
+
 [#protected_derived]
 == protected_derived
 
@@ -528,10 +597,20 @@ class protected_derived
 |===
 | Name
 | Description
+| link:#base_base-base_base_inherited[`base_base_inherited`] 
+| This function should be indirectly inherited by derived classes.
+| link:#base-base_inherited[`base_inherited`] 
+| This function should be inherited by derived classes.
+| link:#base-base_shadowed[`base_shadowed`] 
+| This function should shadow the excluded_base function.
 | link:#protected_derived-derived_shadowed[`derived_shadowed`] 
 | This function should shadow the base class function.
+| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] 
+| This function should be indirectly inherited by derived classes.
 | link:#protected_derived-do_derived_shadowed[`do_derived_shadowed`] 
 | This function should shadow the base class function.
+| link:#protected_derived-excluded_inherited[`excluded_inherited`] 
+| This function should be inherited by derived classes.
 |===
 
 === Protected Member Functions
@@ -540,28 +619,14 @@ class protected_derived
 |===
 | Name
 | Description
-| link:#base_base-base_base_inherited[`base_base_inherited`] 
-| This function should be indirectly inherited by derived classes.
-| link:#base-base_inherited[`base_inherited`] 
-| This function should be inherited by derived classes.
-| link:#base-base_shadowed[`base_shadowed`] 
-| This function should shadow the excluded_base function.
-| link:#base-derived_shadowed[`derived_shadowed`] 
-| This function should be shadowed by derived classes.
-| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] 
-| This function should be indirectly inherited by derived classes.
 | link:#base-do_base_inherited[`do_base_inherited`] 
 | This function should be inherited by derived classes.
 | link:#base-do_base_shadowed[`do_base_shadowed`] 
 | This function should shadow the excluded_base function.
-| link:#base-do_derived_shadowed[`do_derived_shadowed`] 
-| This function should be shadowed by derived classes.
 | link:#protected_derived-do_excluded_inherited[`do_excluded_inherited`] 
 | This function should be inherited by derived classes.
 | link:#protected_derived-do_shadowed[`do_shadowed`] 
 | This function should be shadowed by derived classes.
-| link:#protected_derived-excluded_inherited[`excluded_inherited`] 
-| This function should be inherited by derived classes.
 |===
 
 [#protected_derived-derived_shadowed]
@@ -602,8 +667,8 @@ do_derived_shadowed();
 
 A class that should inherit functions as protected.
 
-[#protected_derived-do_excluded_inherited]
-== link:#protected_derived[protected_derived]::do_excluded_inherited
+[#protected_derived-excluded_inherited]
+== link:#protected_derived[protected_derived]::excluded_inherited
 
 This function should be inherited by derived classes.
 
@@ -614,13 +679,13 @@ Declared in `<copy‐dependencies.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 excluded_base&
-do_excluded_inherited();
+excluded_inherited();
 ----
 
-[#protected_derived-do_shadowed]
-== link:#protected_derived[protected_derived]::do_shadowed
+[#protected_derived-do_excluded_inherited]
+== link:#protected_derived[protected_derived]::do_excluded_inherited
 
-This function should be shadowed by derived classes.
+This function should be inherited by derived classes.
 
 === Synopsis
 
@@ -629,13 +694,13 @@ Declared in `<copy‐dependencies.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 excluded_base&
-do_shadowed();
+do_excluded_inherited();
 ----
 
-[#protected_derived-excluded_inherited]
-== link:#protected_derived[protected_derived]::excluded_inherited
+[#protected_derived-do_shadowed]
+== link:#protected_derived[protected_derived]::do_shadowed
 
-This function should be inherited by derived classes.
+This function should be shadowed by derived classes.
 
 === Synopsis
 
@@ -644,7 +709,7 @@ Declared in `<copy‐dependencies.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 excluded_base&
-excluded_inherited();
+do_shadowed();
 ----