feat: add Info::Implicit flag

Author: sdkrystian

include/mrdox/Metadata/Info.hpp

@@ -80,6 +80,19 @@ struct MRDOX_VISIBLE
     */
     AccessKind Access = AccessKind::None;
 
+    /** Implicitly extracted flag.
+
+        This flag distinguishes primary `Info` from `Info` dependencies.
+
+        A primary `Info` is one which was extracted during AST traversal
+        because it satisfied all configured conditions to be extracted.
+
+        An `Info` dependency is one which does not meet the configured
+        conditions for extraction, but was extracted due to it being used
+        by a primary `Info`.
+    */
+    bool Implicit = true;
+
     /** In-order List of parent namespaces.
     */
     std::vector<SymbolID> Namespace;

src/lib/AST/ASTVisitor.cpp

@@ -186,26 +186,22 @@ class ASTVisitor
         return nullptr;
     }
 
-    template<typename InfoTy>
-    InfoTy&
-    createInfo(const SymbolID& id)
-    {
-        auto [it, inserted] = info_.emplace(
-            std::make_unique<InfoTy>(id));
-        MRDOX_ASSERT(inserted);
-        return static_cast<InfoTy&>(*it->get());
-    }
-
     template<typename InfoTy>
     std::pair<InfoTy&, bool>
     getOrCreateInfo(const SymbolID& id)
     {
-        if(Info* info = getInfo(id))
+        Info* info = getInfo(id);
+        bool created = false;
+        if(! info)
         {
-            MRDOX_ASSERT(info->Kind == InfoTy::kind_id);
-            return {static_cast<InfoTy&>(*info), false};
+            auto [it, inserted] = info_.emplace(
+                std::make_unique<InfoTy>(id));
+            info = it->get();
+            created = true;
         }
-        return {createInfo<InfoTy>(id), true};
+        MRDOX_ASSERT(info->Kind == InfoTy::kind_id);
+        info->Implicit &= forceExtract_;
+        return {static_cast<InfoTy&>(*info), created};
     }
 
     Info&
@@ -1971,6 +1967,7 @@ class ASTVisitor
                 if(Info* parent = getInfo(parent_id))
                 {
                     MRDOX_ASSERT(parent->isRecord());
+                    parent->Implicit &= forceExtract_;
                     static_cast<RecordInfo*>(parent)->Friends.emplace_back(I.id);
                 }
 

src/lib/AST/AnyBlock.hpp

@@ -289,6 +289,9 @@ class InfoPartBlock
         : br_(br)
         , I(I)
     {
+        // we have to clear Info::Implicit here
+        // because bitstream elides zero values
+        I.Implicit = false;
     }
 
     Error
@@ -301,6 +304,8 @@ class InfoPartBlock
             return decodeRecord(R, I.id, Blob);
         case INFO_PART_ACCESS:
             return decodeRecord(R, I.Access, Blob);
+        case INFO_PART_IMPLICIT:
+            return decodeRecord(R, I.Implicit, Blob);
         case INFO_PART_NAME:
             return decodeRecord(R, I.Name, Blob);
         case INFO_PART_PARENTS:

src/lib/AST/BitcodeIDs.hpp

@@ -87,6 +87,7 @@ enum RecordID
 
     INFO_PART_ID,
     INFO_PART_ACCESS,
+    INFO_PART_IMPLICIT,
     INFO_PART_NAME,
     INFO_PART_PARENTS,
     SOURCE_INFO_DEFLOC,

src/lib/AST/BitcodeWriter.cpp

@@ -267,6 +267,7 @@ RecordIDNameMap = []()
         {FUNCTION_PARAM_DEFAULT, {"Default", &StringAbbrev}},
         {INFO_PART_ACCESS, {"InfoAccess", &Integer32Abbrev}},
         {INFO_PART_ID, {"InfoID", &SymbolIDAbbrev}},
+        {INFO_PART_IMPLICIT, {"InfoImplicit", &BoolAbbrev}},
         {INFO_PART_NAME, {"InfoName", &StringAbbrev}},
         {INFO_PART_PARENTS, {"InfoParents", &SymbolIDsAbbrev}},
         {JAVADOC_NODE_ADMONISH, {"JavadocNodeAdmonish", &Integer32Abbrev}},
@@ -325,7 +326,7 @@ RecordsByBlock{
     {BI_VERSION_BLOCK_ID, {VERSION}},
     // Info part
     {BI_INFO_PART_ID,
-        {INFO_PART_ID, INFO_PART_ACCESS,
+        {INFO_PART_ID, INFO_PART_ACCESS, INFO_PART_IMPLICIT,
          INFO_PART_NAME, INFO_PART_PARENTS}},
     // SourceInfo
     {BI_SOURCE_INFO_ID,
@@ -756,6 +757,7 @@ emitInfoPart(
     StreamSubBlockGuard Block(Stream, BI_INFO_PART_ID);
     emitRecord(I.id, INFO_PART_ID);
     emitRecord(I.Access, INFO_PART_ACCESS);
+    emitRecord(I.Implicit, INFO_PART_IMPLICIT);
     emitRecord(I.Name, INFO_PART_NAME);
     emitRecord(I.Namespace, INFO_PART_PARENTS);
     emitBlock(I.javadoc);

src/lib/Metadata/DomMetadata.cpp

@@ -655,6 +655,7 @@ DomInfo<T>::construct() const
         { "id",         toBase16(I_.id) },
         { "kind",       toString(I_.Kind) },
         { "access",     toString(I_.Access) },
+        { "implicit",   I_.Implicit },
         { "name",       I_.Name },
         { "namespace",  dom::newArray<DomSymbolArray>(
                             I_.Namespace, domCorpus_) },

src/lib/Metadata/Reduce.cpp

@@ -83,6 +83,7 @@ void mergeInfo(Info& I, Info&& Other)
         I.Namespace = std::move(Other.Namespace);
     if(I.Access == AccessKind::None)
         I.Access = Other.Access;
+    I.Implicit &= Other.Implicit;
     // append javadocs
     if(! I.javadoc)
         I.javadoc = std::move(Other.javadoc);