chore: eliminate ToolExecutor, replace Corpus::index with iterator access, add ExecutionContext which skips bitcode

Author: sdkrystian

include/mrdox/Corpus.hpp

@@ -37,6 +37,8 @@ class MRDOX_VISIBLE
     {
     }
 
+
+    class iterator;
 public:
     /** Destructor.
     */
@@ -50,12 +52,19 @@ class MRDOX_VISIBLE
     */
     Config const& config;
 
-    /** Return a sorted index of all symbols.
+    /** Return the begin iterator for the index of all symbols.
+    */
+    MRDOX_DECL
+    virtual
+    iterator
+    begin() const noexcept = 0;
+
+    /** Return the end iterator for the index.
     */
     MRDOX_DECL
     virtual
-    std::vector<Info const*> const&
-    index() const noexcept = 0;
+    iterator
+    end() const noexcept = 0;
 
     /** Return the metadata for the global namespace.
     */
@@ -180,6 +189,73 @@ traverse(
                 std::forward<Args>(args)...);
 }
 
+class Corpus::iterator
+{
+    const Corpus* corpus_;
+    const Info* val_;
+    const Info*(*next_)(const Corpus*, const Info*);
+
+public:
+    using value_type = const Info;
+    using size_type = std::size_t;
+    using difference_type = std::ptrdiff_t;
+    using pointer = value_type*;
+    using reference = value_type&;
+    using const_pointer = const value_type*;
+    using const_reference = const value_type&;
+
+    iterator() = default;
+    iterator(const iterator&) = default;
+    iterator& operator=(const iterator&) = default;
+
+    iterator(
+        const Corpus* corpus,
+        const Info* val,
+        const Info*(*next)(const Corpus*, const Info*))
+        : corpus_(corpus)
+        , val_(val)
+        , next_(next)
+    {
+    }
+
+    iterator& operator++() noexcept
+    {
+        MRDOX_ASSERT(val_);
+        val_ = next_(corpus_, val_);
+        return *this;
+    }
+
+    iterator operator++(int) noexcept
+    {
+        MRDOX_ASSERT(val_);
+        auto temp = *this;
+        val_ = next_(corpus_, val_);
+        return temp;
+    }
+
+    const_pointer operator->() const noexcept
+    {
+        MRDOX_ASSERT(val_);
+        return val_;
+    }
+
+    const_reference operator*() const noexcept
+    {
+        MRDOX_ASSERT(val_);
+        return *val_;
+    }
+
+    bool operator==(iterator const& other) const noexcept
+    {
+        return val_ == other.val_;
+    }
+
+    bool operator!=(iterator const& other) const noexcept
+    {
+        return val_ != other.val_;
+    }
+};
+
 } // mrdox
 } // clang
 

src/lib/-XML/XMLWriter.cpp

@@ -171,23 +171,23 @@ writeIndex()
     if(options_.safe_names)
     {
         SafeNames names(corpus_);
-        for(auto I : corpus_.index())
+        for(auto& I : corpus_)
         {
-            auto safe_name = names.getUnqualified(I->id);
+            auto safe_name = names.getUnqualified(I.id);
             tags_.write("symbol", {}, {
                 { "safe", safe_name },
-                { "name", corpus_.getFullyQualifiedName(*I, temp) },
-                { "tag", toString(I->Kind) },
-                { I->id } });
+                { "name", corpus_.getFullyQualifiedName(I, temp) },
+                { "tag", toString(I.Kind) },
+                { I.id } });
         }
     }
     else
     {
-        for(auto I : corpus_.index())
+        for(auto& I : corpus_)
             tags_.write("symbol", {}, {
-                { "name", corpus_.getFullyQualifiedName(*I, temp) },
-                { "tag", toString(I->Kind) },
-                { I->id } });
+                { "name", corpus_.getFullyQualifiedName(I, temp) },
+                { "tag", toString(I.Kind) },
+                { I.id } });
     }
     tags_.close("symbols");
 }

src/lib/AST/AnyBlock.hpp

@@ -650,15 +650,15 @@ class TemplateArgBlock
         {
             if(! I_->isTemplate())
                 return formatError("only TemplateTArgs may reference a template");
-            return decodeRecord(R, 
+            return decodeRecord(R,
                 static_cast<TemplateTArg&>(
                     *I_.get()).Template, Blob);
         }
         case TEMPLATE_ARG_NAME:
         {
             if(! I_->isTemplate())
                 return formatError("only TemplateTArgs may have a template name");
-            return decodeRecord(R, 
+            return decodeRecord(R,
                 static_cast<TemplateTArg&>(
                     *I_.get()).Name, Blob);
         }

src/lib/AST/Bitcode.cpp

@@ -14,33 +14,5 @@
 namespace clang {
 namespace mrdox {
 
-#if 0
-void
-insertBitcode(
-    ExecutionContext& ex,
-    Bitcode&& bitcode)
-{
-    // bitcode.data.
-    ex.reportResult(
-        StringRef(bitcode.id),
-        std::move(bitcode.data));
-}
-
-Bitcodes
-collectBitcodes(
-    ToolExecutor& ex)
-{
-    Bitcodes results;
-    ex.getToolResults()->forEachResult(
-        [&](StringRef Key, StringRef Value)
-        {
-            auto result = results.try_emplace(
-                Key, std::vector<StringRef>());
-            result.first->second.emplace_back(Value);
-        });
-    return results;
-}
-#endif
-
 } // mrdox
 } // clang

src/lib/AST/Bitcode.hpp

@@ -12,7 +12,6 @@
 #ifndef MRDOX_LIB_AST_BITCODE_HPP
 #define MRDOX_LIB_AST_BITCODE_HPP
 
-#include "lib/Lib/ToolExecutor.hpp"
 #include <mrdox/Platform.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Metadata/Info.hpp>