add verbose config option

Author: vinniefalco

include/mrdox/Config.hpp

@@ -50,6 +50,7 @@ class Config
     llvm::SmallString<0> configDir_;
     std::string sourceRoot_;
     std::vector<std::string> inputFileFilter_;
+    bool verbose_ = true;
 
     explicit Config(llvm::StringRef configDir);
 
@@ -106,6 +107,14 @@ class Config
     //
     //--------------------------------------------
 
+    /** Return true if tools should show progress.
+    */
+    bool
+    verbose() const noexcept
+    {
+        return verbose_;
+    }
+
     /** Return the full path to the configuration directory.
 
         The returned path will always be POSIX
@@ -151,6 +160,15 @@ class Config
     //
     //--------------------------------------------
 
+    /** Set whether tools should show progress.
+    */
+    void
+    setVerbose(
+        bool verbose) noexcept
+    {
+        verbose_ = verbose;
+    }
+
     /** Set the directory where the input files are stored.
 
         Symbol documentation will not be emitted unless

include/mrdox/Corpus.hpp

@@ -36,6 +36,15 @@ struct TypedefInfo;
 */
 class Corpus
 {
+    Config const& config_;
+
+    explicit
+    Corpus(
+        Config const& config) noexcept
+        : config_(config)
+    {
+    }
+
 public:
     /** Index of all emitted symbols.
     */
@@ -58,7 +67,10 @@ class Corpus
 
     /** Build the intermediate representation of the code being documented.
 
-        @par R The diagnostic reporting object to
+        @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]]
@@ -73,7 +85,7 @@ class Corpus
 
         @return true upon success.
 
-        @par R The diagnostic reporting object to
+        @param R The diagnostic reporting object to
         use for delivering errors and information.
     */
     [[nodiscard]]
@@ -173,14 +185,14 @@ class Corpus
 
     /** Insert this element and all its children into the Corpus.
 
-        @par Thread Safety
+        @param Thread Safety
         May be called concurrently.
     */
     void insert(std::unique_ptr<Info> Ip);
 
     /** Insert Info into the index
 
-        @par Thread Safety
+        @param Thread Safety
         May be called concurrently.
     */
     void insertIntoIndex(Info const& I);
@@ -197,8 +209,6 @@ class Corpus
 
 
 private:
-    Corpus() = default;
-
     llvm::sys::Mutex infoMutex;
     llvm::sys::Mutex allSymbolsMutex;
     bool isCanonical_ = false;

source/lib/Config.cpp

@@ -28,6 +28,7 @@ struct Config::Options
 
     std::string source_root;
     std::vector<std::string> input_include;
+    bool verbose = true;
 };
 
 } // mrdox
@@ -53,6 +54,7 @@ struct llvm::yaml::MappingTraits<
     static void mapping(
         IO& io, clang::mrdox::Config::Options& opt)
     {
+        io.mapOptional("verbose",      opt.verbose);
         io.mapOptional("source-root",  opt.source_root);
         io.mapOptional("input",        opt.input_include);
     }
@@ -121,6 +123,7 @@ loadFromFile(
     }
 
     // apply opt to Config
+    (*config)->setVerbose(opt.verbose);
     if(auto err = (*config)->setSourceRoot(opt.source_root))
         return err;
 
@@ -166,7 +169,7 @@ setSourceRoot(
     namespace path = llvm::sys::path;
 
     llvm::SmallString<0> temp(dirPath);
-    if(! path::is_absolute(sourceRoot_))
+    if(! path::is_absolute(sourceRoot_, path::Style::posix))
     {
         std::error_code ec = fs::make_absolute(temp);
         if(ec)

source/lib/Corpus.cpp

@@ -42,14 +42,15 @@ build(
     Config const& config,
     Reporter& R)
 {
-    auto up = std::unique_ptr<Corpus>(new Corpus);
+    auto up = std::unique_ptr<Corpus>(new Corpus(config));
     Corpus& corpus = *up;
 
     // Traverse the AST for all translation units
     // and emit serializd bitcode into tool results.
     // This operation happens ona thread pool.
 
-    llvm::outs() << "Mapping declarations\n";
+    if(config.verbose())
+        llvm::outs() << "Mapping declarations\n";
     llvm::Error err = ex.execute(
         makeToolFactory(*ex.getExecutionContext(), config, R),
         config.ArgAdjuster);
@@ -72,7 +73,8 @@ build(
     // a vector of one or more bitcodes. These will
     // be merged later.
 
-    llvm::outs() << "Collecting symbols\n";
+    if(config.verbose())
+        llvm::outs() << "Collecting symbols\n";
     llvm::StringMap<std::vector<StringRef>> USRToBitcode;
     ex.getToolResults()->forEachResult(
         [&](StringRef Key, StringRef Value)
@@ -82,7 +84,8 @@ build(
         });
 
     // First reducing phase (reduce all decls into one info per decl).
-    llvm::outs() << "Reducing " << USRToBitcode.size() << " declarations\n";
+    if(config.verbose())
+        llvm::outs() << "Reducing " << USRToBitcode.size() << " declarations\n";
     std::atomic<bool> GotFailure;
     GotFailure = false;
     // VFALCO Should this concurrency be a command line option?
@@ -127,8 +130,9 @@ build(
 
     Pool.wait();
 
-    llvm::outs() <<
-        "Collected " << corpus.InfoMap.size() << " symbols.\n";
+    if(config.verbose())
+        llvm::outs() << "Collected " <<
+            corpus.InfoMap.size() << " symbols.\n";
 
     if(GotFailure)
     {
@@ -172,7 +176,8 @@ canonicalize(
     }
 
     Temps t;
-    R.print("Canonicalizing...");
+    if(config_.verbose())
+        R.print("Canonicalizing...");
     if(! canonicalize(*p, t, R))
         return false;
     isCanonical_ = true;

source/tests/TestMain.cpp

@@ -35,6 +35,8 @@ testMain(
         if(auto err = (*config)->setSourceRoot((*config)->configDir()))
             return (void)R.error(err, "set source root to '", (*config)->configDir(), "'");
 
+        (*config)->setVerbose(false);
+
         // We need a different config for each directory
         // passed on the command line, and thus each must
         // also have a separate Tester.