tidy up Corpus API

Author: vinniefalco

README.adoc

@@ -3,7 +3,7 @@
 == Install
 
 This library depends on a recent version of LLVM.
-Here are the instructions to install LVVM with the settings required by this project.
+Here are the instructions to install LLVM with the settings required by this project.
 
 [source,bash]
 ----

include/mrdox/Config.hpp

@@ -99,9 +99,6 @@ class Config
     bool IgnoreMappingFailures = false;
 
 public:
-    Config(Config&&) = delete;
-    Config& operator=(Config&&) = delete;
-
     //--------------------------------------------
     //
     // Observers

include/mrdox/Corpus.hpp

@@ -19,6 +19,7 @@
 #include <mrdox/meta/Types.hpp>
 #include <clang/Tooling/Execution.h>
 #include <llvm/Support/Mutex.h>
+#include <memory>
 #include <type_traits>
 #include <vector>
 
@@ -29,67 +30,28 @@ namespace mrdox {
 */
 class Corpus
 {
-    Config const& config_;
-
     explicit
     Corpus(
-        Config const& config) noexcept
-        : config_(config)
+        std::shared_ptr<Config const> config) noexcept
+        : config_(std::move(config))
     {
     }
 
-public:
-    /** Index of all emitted symbols.
-    */
-    Index Idx;
-
-    /** Table of Info keyed on Symbol ID.
-    */
-    llvm::StringMap<std::unique_ptr<Info>> InfoMap;
-
-    /** List of all symbols.
-    */
-    std::vector<SymbolID> allSymbols;
-
 public:
     //--------------------------------------------
     //
-    // Modifiers
+    // Observers
     //
     //--------------------------------------------
 
-    /** Build the intermediate representation of the code being documented.
-
-        @param config The configuration, whose lifetime
-        must extend until the corpus is destroyed.
-
-        @param R The diagnostic reporting object to
-        use for delivering errors and information.
-    */
-    [[nodiscard]]
-    static
-    llvm::Expected<std::unique_ptr<Corpus>>
-    build(
-        tooling::ToolExecutor& ex,
-        Config const& config,
-        Reporter& R);
-
-    /** Sort an array of Info by fully qualified name
-    */
-
-    /** Store the Info in the tool results, keyed by SymbolID.
+    /** Return the ID of the global namespace.
     */
     static
-    void
-    reportResult(
-        tooling::ExecutionContext& exc,
-        Info const& I);
-
-    //--------------------------------------------
-    //
-    // Observers
-    //
-    //--------------------------------------------
+    SymbolID
+    globalNamespaceID() noexcept
+    {
+        return EmptySID;
+    }
 
     /** Return true if s0 is less than s1.
 
@@ -106,11 +68,13 @@ class Corpus
         llvm::StringRef symbolName0,
         llvm::StringRef symbolName1) noexcept;
 
-    /** Return the ID of the global namespace.
+    /** Return the Config used to generate this corpus.
     */
-    static
-    SymbolID
-    globalNamespaceID() noexcept;
+    std::shared_ptr<Config const> const&
+    config() const noexcept
+    {
+        return config_;
+    }
 
     /** Return the metadata for the global namespace.
     */
@@ -119,11 +83,7 @@ class Corpus
 
     /** Return true if an Info with the specified symbol ID exists.
     */
-    bool
-    exists(SymbolID const& id) const noexcept
-    {
-        return find<Info>(id) != nullptr;
-    }
+    bool exists(SymbolID const& id) const noexcept;
 
     /** Return a pointer to the Info with the specified symbol ID, or nullptr.
     */
@@ -166,7 +126,55 @@ class Corpus
         assert(p != nullptr);
         return *p;
     }
-    
+
+    /** Return the list of all uniquely identified symbols.
+    */
+    std::vector<SymbolID> const&
+    allSymbols() const noexcept
+    {
+        return allSymbols_;
+    }
+
+    //--------------------------------------------
+    //
+    // Modifiers
+    //
+    //--------------------------------------------
+
+    /** Build the intermediate representation of the code being documented.
+
+        @param config A shared pointer to the configuration.
+
+        @param R The diagnostic reporting object to
+        use for delivering errors and information.
+    */
+    [[nodiscard]]
+    static
+    llvm::Expected<std::unique_ptr<Corpus>>
+    build(
+        tooling::ToolExecutor& ex,
+        std::shared_ptr<Config const> config,
+        Reporter& R);
+
+    [[nodiscard]]
+    static
+    llvm::Expected<std::unique_ptr<Corpus>>
+    build(
+        tooling::ToolExecutor& ex,
+        Config const& config,
+        Reporter& R)
+    {
+        return build(ex, std::make_shared<Config const>(config), R);
+    }
+
+    /** Store the Info in the tool results, keyed by SymbolID.
+    */
+    static
+    void
+    reportResult(
+        tooling::ExecutionContext& exc,
+        Info const& I);
+
 private:
     struct Temps;
 
@@ -211,6 +219,17 @@ class Corpus
     bool canonicalize(llvm::SmallVectorImpl<MemberTypeInfo>& list, Temps& t, Reporter& R);
 
 private:
+    std::shared_ptr<Config const> config_;
+
+    // Index of all emitted symbols.
+    Index Idx;
+
+    // Table of Info keyed on Symbol ID.
+    llvm::StringMap<std::unique_ptr<Info>> InfoMap;
+
+    // list of all symbols
+    std::vector<SymbolID> allSymbols_;
+
     llvm::sys::Mutex infoMutex;
     llvm::sys::Mutex allSymbolsMutex;
     bool isCanonical_ = false;

include/mrdox/format/FlatWriter.hpp

@@ -38,7 +38,12 @@ struct Scope;
 class FlatWriter
 {
 protected:
+    // The stream being written to
     llvm::raw_ostream& os_;
+
+    // Path to file being written, or empty
+    llvm::StringRef filePath_;
+
     Corpus const& corpus_;
     Config const& config_;
     Reporter& R_;
@@ -47,6 +52,7 @@ class FlatWriter
     */
     FlatWriter(
         llvm::raw_ostream& os,
+        llvm::StringRef filePath,
         Corpus const& corpus,
         Config const& config,
         Reporter& R) noexcept;

include/mrdox/meta/Javadoc.hpp

@@ -359,6 +359,9 @@ struct Javadoc
     */
     void merge(Javadoc&& other);
 
+    List<Block>::const_iterator
+    findBrief() const noexcept;
+
     /** Calculate the brief.
 
         The implementation calls this function once,
@@ -425,7 +428,7 @@ struct Javadoc
     {
         append(blocks_, std::move(node));
     }
-    
+
     void append(Param node)
     {
         append(params_, std::move(node));

source/lib/Corpus.cpp

@@ -62,6 +62,28 @@ mergeInfos(std::vector<std::unique_ptr<Info>>& Values)
     }
 }
 
+//------------------------------------------------
+//
+// Observers
+//
+//------------------------------------------------
+
+/** Return the metadata for the global namespace.
+*/
+NamespaceInfo const&
+Corpus::
+globalNamespace() const noexcept
+{
+    return get<NamespaceInfo>(globalNamespaceID());
+}
+
+bool
+Corpus::
+exists(SymbolID const& id) const noexcept
+{
+    return find<Info>(id) != nullptr;
+}
+
 //------------------------------------------------
 //
 // Modifiers
@@ -72,30 +94,30 @@ llvm::Expected<std::unique_ptr<Corpus>>
 Corpus::
 build(
     tooling::ToolExecutor& ex,
-    Config const& config,
+    std::shared_ptr<Config const> config,
     Reporter& R)
 {
-    std::unique_ptr<Corpus> corpus(new Corpus(config));
+    std::unique_ptr<Corpus> corpus(new Corpus(std::move(config)));
 
     // Traverse the AST for all translation units
     // and emit serializd bitcode into tool results.
     // This operation happens ona thread pool.
-    if(config.verbose())
+    if(corpus->config()->verbose())
         R.print("Mapping declarations");
     if(auto err = ex.execute(
         makeFrontendActionFactory(
-            *ex.getExecutionContext(), config, R),
-        config.ArgAdjuster))
+            *ex.getExecutionContext(), *corpus->config(), R),
+        corpus->config()->ArgAdjuster))
     {
-        if(! config.IgnoreMappingFailures)
+        if(! corpus->config()->IgnoreMappingFailures)
             return err;
         R.print("warning: mapping failed because ", toString(std::move(err)));
     }
 
     // Collect the symbols. Each symbol will have
     // a vector of one or more bitcodes. These will
     // be merged later.
-    if(config.verbose())
+    if(corpus->config()->verbose())
         R.print("Collecting symbols");
     using USRToBitcodeType = llvm::StringMap<std::vector<StringRef>>;
     USRToBitcodeType USRToBitcode;
@@ -107,7 +129,7 @@ build(
         });
 
     // First reducing phase (reduce all decls into one info per decl).
-    if(config.verbose())
+    if(corpus->config()->verbose())
         R.print("Reducing ", USRToBitcode.size(), " declarations");
     std::atomic<bool> GotFailure;
     GotFailure = false;
@@ -159,7 +181,7 @@ build(
 
     Pool.wait();
 
-    if(config.verbose())
+    if(corpus->config()->verbose())
         R.print("Collected ", corpus->InfoMap.size(), " symbols.\n");
 
     if(GotFailure)
@@ -249,20 +271,6 @@ symbolCompare(
     return s_cmp < 0;
 }
 
-SymbolID
-Corpus::
-globalNamespaceID() noexcept
-{
-    return EmptySID;
-}
-
-NamespaceInfo const&
-Corpus::
-globalNamespace() const noexcept
-{
-    return get<NamespaceInfo>(globalNamespaceID());
-}
-
 //------------------------------------------------
 //
 // Implementation
@@ -365,7 +373,7 @@ insertIntoIndex(
     }
 
     // also insert into allSymbols
-    allSymbols.emplace_back(I.USR);
+    allSymbols_.emplace_back(I.USR);
 }
 
 //------------------------------------------------
@@ -383,15 +391,15 @@ canonicalize(Reporter& R)
         return false;
     }
 
-    if(config_.verbose())
+    if(config_->verbose())
         R.print("Canonicalizing...");
 
     Temps t;
 
     if(! canonicalize(*p, t, R))
         return false;
 
-    if(! canonicalize(allSymbols, t, R))
+    if(! canonicalize(allSymbols_, t, R))
         return false;
 
     isCanonical_ = true;