UndocumentedInfoSet stores InfoKind

#feat

Author: alandefreitas

src/lib/AST/ASTVisitor.cpp

@@ -3362,9 +3362,9 @@ checkUndocumented(
     }
     // If the symbol is undocumented, check if we haven't seen a
     // documented version before.
-    auto const it = info_.find(id);
-    if (it != info_.end() &&
-        it->get()->javadoc)
+    if (auto const infoIt = info_.find(id);
+        infoIt != info_.end() &&
+        infoIt->get()->javadoc)
     {
         return {};
     }
@@ -3373,7 +3373,17 @@ checkUndocumented(
     // symbols we've seen so far in this translation unit.
     if (config_->warnIfUndocumented)
     {
-        undocumented_.insert({id, extractName(D)});
+        auto const undocIt = undocumented_.find(id);
+        if (undocIt == undocumented_.end())
+        {
+            InfoKind const kind = InfoTy::kind_id;
+            undocumented_.insert(UndocumentedInfo{id, extractName(D), kind});
+        }
+        // Populate the location
+        auto handle = undocumented_.extract(undocIt);
+        UndocumentedInfo& UI = handle.value();
+        populate(dynamic_cast<SourceInfo&>(UI), D);
+        undocumented_.insert(std::move(handle));
     }
     return Unexpected(Error("Undocumented"));
 }

src/lib/Gen/hbs/Builder.cpp

@@ -202,7 +202,7 @@ Builder(
                 return nullptr;
             }
             dom::Value decls = sourceInfo.get("decl");
-            if(dom::Value def = sourceInfo.get("def"))
+            if (dom::Value def = sourceInfo.get("def"))
             {
                 // for classes/enums, prefer the definition
                 if (dom::Value const kind = v.get("kind");
@@ -423,7 +423,7 @@ commonTemplatesDir() const
 
 std::string
 Builder::
-commonTemplatesDir(std::string_view subdir) const
+commonTemplatesDir(std::string_view const subdir) const
 {
     Config const& config = domCorpus->config;
     return files::appendPath(

src/lib/Lib/ExecutionContext.cpp

@@ -59,15 +59,7 @@ report(
     UndocumentedInfoSet&& undocumented)
 {
     InfoSet info = std::move(results);
-    // KRYSTIAN TODO: read stage will be required to
-    // update Info references once we switch to using Info*
-    #if 0
-    {
-        std::shared_lock<std::shared_mutex> read_lock(mutex_);
-    }
-    #endif
-
-    std::unique_lock<std::shared_mutex> write_lock(mutex_);
+    std::unique_lock write_lock(mutex_);
 
     // Add all new Info to the existing set.
     info_.merge(info);
@@ -83,16 +75,14 @@ report(
     // Merge diagnostics and report any new messages.
     diags_.mergeAndReport(std::move(diags));
 
-
-
     // Merge undocumented symbols and remove any symbols
     // from undocumented that we can find in info_ with
     // documentation from other translation units.
     undocumented_.merge(undocumented);
     for (auto it = undocumented_.begin(); it != undocumented_.end();)
     {
-        auto infoIt = info_.find(it->first);
-        if (infoIt != info_.end() &&
+        if (auto infoIt = info_.find(it->id);
+            infoIt != info_.end() &&
             infoIt->get()->javadoc)
         {
             it = undocumented_.erase(it);

src/lib/Lib/Info.hpp

@@ -116,7 +116,25 @@ struct InfoPtrEqual
 using InfoSet = std::unordered_set<
     std::unique_ptr<Info>, InfoPtrHasher, InfoPtrEqual>;
 
-struct SymbolIDNameHasher {
+struct UndocumentedInfo final : SourceInfo {
+    SymbolID id;
+    std::string name;
+    InfoKind kind;
+
+    constexpr
+    UndocumentedInfo(
+        SymbolID id_,
+        std::string name_,
+        InfoKind kind_) noexcept
+        : SourceInfo()
+        , id(id_)
+        , name(std::move(name_))
+        , kind(kind_)
+    {
+    }
+};
+
+struct UndocumentedInfoHasher {
     using is_transparent = void;
 
     std::size_t
@@ -125,41 +143,41 @@ struct SymbolIDNameHasher {
     }
 
     std::size_t
-    operator()(std::pair<SymbolID, std::string> const& I) const {
-        return std::hash<SymbolID>()(I.first);
+    operator()(UndocumentedInfo const& I) const {
+        return std::hash<SymbolID>()(I.id);
     }
 };
 
-struct SymbolIDNameEqual {
+struct UndocumentedInfoEqual {
     using is_transparent = void;
 
     bool
     operator()(
-        std::pair<SymbolID, std::string> const& a,
-        std::pair<SymbolID, std::string> const& b) const
+        UndocumentedInfo const& a,
+        UndocumentedInfo const& b) const
     {
-        return a.first == b.first;
+        return a.id == b.id;
     }
 
     bool
     operator()(
-        std::pair<SymbolID, std::string> const& a,
+        UndocumentedInfo const& a,
         SymbolID const& b) const
     {
-        return a.first == b;
+        return a.id == b;
     }
 
     bool
     operator()(
         SymbolID const& a,
-        std::pair<SymbolID, std::string> const& b) const
+        UndocumentedInfo const& b) const
     {
-        return a == b.first;
+        return a == b.id;
     }
 };
 
 using UndocumentedInfoSet = std::unordered_set<
-    std::pair<SymbolID, std::string>, SymbolIDNameHasher, SymbolIDNameEqual>;
+    UndocumentedInfo, UndocumentedInfoHasher, UndocumentedInfoEqual>;
 
 } // clang::mrdocs