Corpus lookup returns references

#improvement

Author: alandefreitas

include/mrdocs/Corpus.hpp

@@ -90,12 +90,12 @@ class MRDOCS_VISIBLE
     /** Return the Info for the matching string in a given context.
     */
     virtual
-    Expected<Info const*>
+    Expected<std::reference_wrapper<Info const>>
     lookup(SymbolID const& context, std::string_view name) const = 0;
 
     /** Return the Info for the matching string in the global context.
     */
-    Expected<Info const*>
+    Expected<std::reference_wrapper<Info const>>
     lookup(std::string_view name) const
     {
         return lookup(SymbolID::global, name);

src/lib/Lib/CorpusImpl.cpp

@@ -221,22 +221,22 @@ isTransparent(Info const& info)
 }
 }
 
-Expected<Info const*>
+Expected<std::reference_wrapper<Info const>>
 CorpusImpl::
 lookup(SymbolID const& context, std::string_view const name) const
 {
     return lookupImpl(*this, context, name);
 }
 
-Expected<Info const*>
+Expected<std::reference_wrapper<Info const>>
 CorpusImpl::
 lookup(SymbolID const& context, std::string_view name)
 {
     return lookupImpl(*this, context, name);
 }
 
 template <class Self>
-Expected<Info const*>
+Expected<std::reference_wrapper<Info const>>
 CorpusImpl::
 lookupImpl(Self&& self, SymbolID const& context, std::string_view name)
 {
@@ -253,7 +253,7 @@ lookupImpl(Self&& self, SymbolID const& context, std::string_view name)
                 name,
                 self.Corpus::qualifiedName(*self.find(context))));
         }
-        return info;
+        return std::cref(*info);
     }
     Expected<ParsedRef> const s = parseRef(name);
     if (!s)
@@ -273,7 +273,7 @@ lookupImpl(Self&& self, SymbolID const& context, std::string_view name)
             name,
             self.Corpus::qualifiedName(*contextPtr)));
     }
-    return res;
+    return std::cref(*res);
 }
 
 template <class Self>

src/lib/Lib/CorpusImpl.hpp

@@ -26,6 +26,7 @@
 #include <mutex>
 #include <string>
 #include <set>
+#include <functional>
 
 namespace clang::mrdocs {
 
@@ -91,10 +92,10 @@ class CorpusImpl final : public Corpus
     Info const*
     find(SymbolID const& id) const noexcept override;
 
-    Expected<Info const*>
+    Expected<std::reference_wrapper<Info const>>
     lookup(SymbolID const& context, std::string_view name) const override;
 
-    Expected<Info const*>
+    Expected<std::reference_wrapper<Info const>>
     lookup(SymbolID const& context, std::string_view name);
 
     /** Build metadata for a set of translation units.
@@ -141,7 +142,7 @@ class CorpusImpl final : public Corpus
 
     template <class Self>
     static
-    Expected<Info const*>
+    Expected<std::reference_wrapper<Info const>>
     lookupImpl(
         Self&& self,
         SymbolID const& context,

src/lib/Metadata/Finalizers/JavadocFinalizer.cpp

@@ -112,12 +112,10 @@ void
 JavadocFinalizer::
 finalize(doc::Reference& ref, bool const emitWarning)
 {
-    if (Expected<Info const*> res
-        = corpus_.lookup(current_context_->id, ref.string))
+    if (auto resRef = corpus_.lookup(current_context_->id, ref.string))
     {
-        Info const* resPtr = *res;
-        MRDOCS_ASSERT(resPtr);
-        ref.id = resPtr->id;
+        Info const& res = *resRef;
+        ref.id = res.id;
     }
     else if (
         emitWarning &&
@@ -136,7 +134,7 @@ finalize(doc::Reference& ref, bool const emitWarning)
             "    {}",
             corpus_.Corpus::qualifiedName(*current_context_),
             ref.string,
-            res.error().reason());
+            resRef.error().reason());
         refWarned_.insert({ref.string, current_context_->Name});
     }
 }
@@ -280,8 +278,8 @@ copyBriefAndDetails(Javadoc& javadoc)
         }
 
         // Find the node to copy from
-        Expected<Info const*> res = corpus_.lookup(current_context_->id, copied->string);
-        if (!res || !*res)
+        auto resRef = corpus_.lookup(current_context_->id, copied->string);
+        if (!resRef)
         {
             if (corpus_.config->warnings &&
                 corpus_.config->warnBrokenRef &&
@@ -292,25 +290,24 @@ copyBriefAndDetails(Javadoc& javadoc)
                     "    {}",
                     corpus_.Corpus::qualifiedName(*current_context_),
                     copied->string,
-                    res.error().reason());
+                    resRef.error().reason());
             }
             continue;
         }
 
         // Ensure the source node is finalized
-        Info const* resPtr = *res;
-        MRDOCS_ASSERT(resPtr);
-        if (!finalized_.contains(resPtr))
+        Info const& res = *resRef;
+        if (!finalized_.contains(&res))
         {
-            operator()(const_cast<Info&>(*resPtr));
+            operator()(const_cast<Info&>(res));
         }
-        if (!resPtr->javadoc)
+        if (!res.javadoc)
         {
             if (corpus_.config->warnings &&
                 corpus_.config->warnBrokenRef &&
                 !refWarned_.contains({copied->string, current_context_->Name}))
             {
-                auto resPrimaryLoc = getPrimaryLocation(*resPtr);
+                auto resPrimaryLoc = getPrimaryLocation(res);
                 this->warn(
                     "{}: Failed to copy documentation from '{}' (no documentation available).\n"
                     "    No documentation available.\n"
@@ -320,15 +317,15 @@ copyBriefAndDetails(Javadoc& javadoc)
                     copied->string,
                     resPrimaryLoc->FullPath,
                     resPrimaryLoc->LineNumber,
-                    corpus_.Corpus::qualifiedName(*resPtr));
+                    corpus_.Corpus::qualifiedName(res));
             }
             continue;
         }
 
         // Copy brief and details
         bool const copyBrief = copied->parts == doc::Parts::all || copied->parts == doc::Parts::brief;
         bool const copyDetails = copied->parts == doc::Parts::all || copied->parts == doc::Parts::description;
-        Javadoc const& src = *resPtr->javadoc;
+        Javadoc const& src = *res.javadoc;
         if (copyBrief && !javadoc.brief)
         {
             javadoc.brief = src.brief;