comments and tidy

Author: vinniefalco

include/mrdox/Corpus.hpp

@@ -21,49 +21,22 @@
 namespace clang {
 namespace mrdox {
 
-class ThreadSafeToolResults
-    : public tooling::ToolResults
-{
-public:
-    void
-    addResult(
-        llvm::StringRef Key,
-        llvm::StringRef Value) override
-    {
-        std::unique_lock<std::mutex> LockGuard(Mutex);
-        Results.addResult(Key, Value);
-    }
-
-    std::vector<std::pair<llvm::StringRef, llvm::StringRef>>
-    AllKVResults() override
-    {
-        return Results.AllKVResults();
-    }
-
-    void
-    forEachResult(
-        llvm::function_ref<void(
-            llvm::StringRef Key, llvm::StringRef Value)> Callback) override
-    {
-        Results.forEachResult(Callback);
-    }
-
-private:
-    tooling::InMemoryToolResults Results;
-    std::mutex Mutex;
-};
-
 /** The collection of declarations in extracted form.
 */
 struct Corpus
 {
-    Corpus() = default;
+    Corpus();
     Corpus(Corpus const&) = delete;
     Corpus& operator=(Corpus const&) = delete;
 
-    // In ToolResults, the Key is the hashed USR and the value is the
-    // bitcode-encoded representation of the Info object.
-    ThreadSafeToolResults toolResults;
+    /** Holds the results of visiting the AST.
+
+        This is a table of key/value pairs where
+        the key is the SHA1 digest of the USR and
+        the value is the bitcode-encoded representation
+        of the Info object.
+    */
+    std::unique_ptr<tooling::ToolResults> toolResults;
 
     Index Idx;
 

source/lib/Visitor.cpp

@@ -39,7 +39,7 @@ Visitor::
 reportResult(
     StringRef Key, StringRef Value)
 {
-    corpus_.toolResults.addResult(Key, Value);
+    corpus_.toolResults->addResult(Key, Value);
 }
 
 template<typename T>

source/lib/jad/Corpus.cpp

@@ -22,6 +22,50 @@
 namespace clang {
 namespace mrdox {
 
+namespace {
+
+class ThreadSafeToolResults
+    : public tooling::ToolResults
+{
+public:
+    void
+    addResult(
+        llvm::StringRef Key,
+        llvm::StringRef Value) override
+    {
+        std::unique_lock<std::mutex> LockGuard(Mutex);
+        Results.addResult(Key, Value);
+    }
+
+    std::vector<std::pair<llvm::StringRef, llvm::StringRef>>
+    AllKVResults() override
+    {
+        return Results.AllKVResults();
+    }
+
+    void
+    forEachResult(
+        llvm::function_ref<void(
+            llvm::StringRef Key, llvm::StringRef Value)> Callback) override
+    {
+        Results.forEachResult(Callback);
+    }
+
+private:
+    tooling::InMemoryToolResults Results;
+    std::mutex Mutex;
+};
+
+} // (anon)
+
+//------------------------------------------------
+
+Corpus::
+Corpus()
+    : toolResults(std::make_unique<ThreadSafeToolResults>())
+{
+}
+
 //------------------------------------------------
 
 llvm::Error
@@ -58,10 +102,13 @@ buildIndex(
     Corpus& corpus,
     Config const& cfg)
 {
-    // Collect values into output by key.
+/*  Collect all symbols. The result is a vector of
+    one or more bitcodes for each symbol. These will
+    be merged later.
+*/
     llvm::outs() << "Collecting symbols\n";
     llvm::StringMap<std::vector<StringRef>> USRToBitcode;
-    corpus.toolResults.forEachResult(
+    corpus.toolResults->forEachResult(
         [&](StringRef Key, StringRef Value)
         {
             auto R = USRToBitcode.try_emplace(Key, std::vector<StringRef>());
@@ -134,6 +181,5 @@ buildIndex(
     return llvm::Error::success();
 }
 
-
 } // mrdox
 } // clang