refine briefs

Author: vinniefalco

include/mrdox/meta/Javadoc.hpp

@@ -259,7 +259,10 @@ struct Javadoc
     //---
 
     Paragraph const*
-    getBrief() const noexcept;
+    getBrief() const noexcept
+    {
+        return brief_.get();
+    }
 
     List<Block> const&
     getBlocks() const noexcept
@@ -287,7 +290,7 @@ struct Javadoc
 
     //---
 
-    Javadoc() noexcept;
+    Javadoc() = default;
 
     /** Constructor
     */
@@ -324,12 +327,11 @@ struct Javadoc
     }
 
     void merge(Javadoc& other);
+    void calculateBrief();
 
 //private:
 public: // VFALCO sigh...
-    static Paragraph const s_empty_;
-
-    Paragraph const* brief_;
+    std::shared_ptr<Paragraph const> brief_;
     List<Block> blocks_;
     List<Param> params_;
     List<TParam> tparams_;

include/mrdox/meta/List.hpp

@@ -16,6 +16,7 @@
 #include <algorithm>
 #include <cstdint>
 #include <iterator>
+#include <memory>
 #include <typeinfo>
 #include <utility>
 
@@ -161,8 +162,9 @@ class List : public ListBase
     std::strong_ordering
     operator<=>(List const& other) const noexcept;
 
-    template<class Pred>
-    bool erase_first_of_if(Pred&& pred) noexcept;
+    template<class U = T, class Pred>
+    std::shared_ptr<U const>
+    extract_first_of(Pred&& pred) noexcept;
 
     template<class U>
     U& emplace_back(U&& u);
@@ -271,7 +273,7 @@ class List<T>::iterator_impl
 
     pointer operator->() const noexcept
     {
-        return reinterpret_cast<T const*>(it_->get());
+        return reinterpret_cast<pointer>(it_->get());
     }
 
     reference operator*() const noexcept
@@ -524,40 +526,42 @@ operator<=>(
 }
 
 template<class T>
-template<class Pred>
-bool
+template<class U, class Pred>
+std::shared_ptr<U const>
 List<T>::
-erase_first_of_if(
+extract_first_of(
     Pred&& pred) noexcept
 {
     if(empty())
-        return false;
-    if(pred(*(reinterpret_cast<
-        T const*>(head_->get()))))
+        return nullptr;
+    if(pred(*reinterpret_cast<pointer>(head_->get())))
     {
+        auto result = std::make_shared<U>(std::move(
+            *reinterpret_cast<U*>(head_->get())));
         head_ = head_->next;
         if(head_ == &end_)
             tail_ = &end_;
         --size_;
-        return true;
+        return result;
     }
     auto prev = head_;
     auto it = head_->next;
     while(it != &end_)
     {
-        if(pred(*reinterpret_cast<
-            T const*>(it->get())))
+        if(pred(*reinterpret_cast<pointer>(it->get())))
         {
+            auto result = std::make_shared<U>(std::move(
+                *reinterpret_cast<U*>(it->get())));
             prev->next = it->next;
             if(it == tail_)
                 tail_ = prev;
             --size_;
-            return true;
+            return result;
         }
         prev = it;
         it = it->next;
     }
-    return false;
+    return nullptr;
 }
 
 template<class T>

source/lib/Corpus.cpp

@@ -309,18 +309,21 @@ insert(std::unique_ptr<Info> Ip)
 {
     assert(! isCanonical_);
 
-    auto const& I = *Ip;
+    auto& I = *Ip;
 
+    // Clean up the javadoc
+    I.javadoc.calculateBrief();
+
+    // Add a reference to this Info in the Index
+    insertIntoIndex(I);
+
+    // This has to come last because we move Ip.
     // Store the Info in the result map
     {
         std::lock_guard<llvm::sys::Mutex> Guard(infoMutex);
         InfoMap[llvm::toStringRef(I.USR)] = std::move(Ip);
     }
-
-    // Add a reference to this Info in the Index
-    insertIntoIndex(I);
-
-    // Visit children
+    // CANNOT touch I or Ip here!
 }
 
 // A function to add a reference to Info in Idx.

source/lib/format/XML.cpp

@@ -222,7 +222,6 @@ Writer::
 writeNamespace(
     NamespaceInfo const& I)
 {
-    writeInfo(I);
 }
 
 void
@@ -462,7 +461,7 @@ XMLGenerator::
 Writer::
 writeJavadoc(Javadoc const& jd)
 {
-    openTag("javadoc");
+    openTag("doc");
     adjustNesting(1);
     if(auto brief = jd.getBrief())
         writeBrief(*brief);
@@ -471,7 +470,7 @@ writeJavadoc(Javadoc const& jd)
     writeNodes(jd.getParams());
     writeNodes(jd.getTParams());
     adjustNesting(-1);
-    closeTag("javadoc");
+    closeTag("doc");
 }
 
 template<class T>
@@ -546,7 +545,7 @@ writeText(
         "<text";
     writeAttrs({
         { "class", tag, ! tag.empty() } });
-    os_ << '>' << text.text << "&#13" << "</text>\n";
+    os_ << '>' << text.text << "</text>\n";
 }
 
 void
@@ -582,7 +581,9 @@ writeParagraph(
 {
     openTag("para", {
         { "class", tag, ! tag.empty() }});
+    adjustNesting(1);
     writeNodes(para.list);
+    adjustNesting(-1);
     closeTag("para");
 }
 

source/lib/meta/Javadoc.cpp

@@ -38,46 +38,19 @@ static_assert(std::is_move_constructible_v<Javadoc::Code>);
 
 //------------------------------------------------
 
-Javadoc::Paragraph const Javadoc::s_empty_;
-
-Javadoc::
-Javadoc() noexcept
-    : brief_(&s_empty_)
-{
-}
-
 Javadoc::
 Javadoc(
     List<Block> blocks,
     List<Param> params,
     List<TParam> tparams,
     Returns returns)
-    : brief_(&s_empty_)
-    , blocks_(std::move(blocks))
+    : blocks_(std::move(blocks))
     , params_(std::move(params))
     , tparams_(std::move(tparams))
     , returns_(std::move(returns))
 {
 }
 
-auto
-Javadoc::
-getBrief() const noexcept ->
-    Paragraph const*
-{
-    Paragraph const* first = nullptr;
-    for(auto const& block : blocks_)
-    {
-        if(block.kind == Kind::brief)
-            return static_cast<Paragraph const*>(&block);
-        if( block.kind == Kind::paragraph && ! first)
-            first = static_cast<Paragraph const*>(&block);
-    }
-    if(first == nullptr)
-        first = &s_empty_;
-    return first;
-}
-
 void
 Javadoc::
 merge(Javadoc& other)
@@ -89,6 +62,30 @@ merge(Javadoc& other)
         returns_ = std::move(other.returns_);
 }
 
+void
+Javadoc::
+calculateBrief()
+{
+    Paragraph* brief = nullptr;
+    for(auto& block : blocks_)
+    {
+        if(block.kind == Kind::brief)
+        {
+            brief = static_cast<Paragraph*>(&block);
+            break;
+        }
+        if(block.kind == Kind::paragraph && ! brief)
+            brief = static_cast<Paragraph*>(&block);
+    }
+    if(brief != nullptr)
+    {
+        brief_ = blocks_.extract_first_of<Paragraph>(
+            [this, brief](Block& block)
+            {
+                return brief == &block;
+            });
+    }
+}
 
 } // mrdox
 } // clang