chore: refactor reporting call sites

Author: vinniefalco

include/mrdox/Support/Error.hpp

@@ -891,66 +891,6 @@ fatal(
 
 //------------------------------------------------
 
-/** Report an error to the console.
-
-    @param text The message contents. A newline
-    will be added automatically to the output.
-*/
-MRDOX_DECL
-void
-reportError(
-    std::string_view text);
-
-/** Format an error to the console.
-
-    @param fs The operation format string.
-
-    @param arg0,args The arguments to use
-    with the format string.
-*/
-template<class Arg0, class... Args>
-void
-reportError(
-    fmt::format_string<Arg0, Args...> fs,
-    Arg0&& arg0, Args&&... args)
-{
-    reportError(fmt::format(fs,
-        std::forward<Arg0>(arg0),
-        std::forward<Args>(args)...));
-}
-
-/** Format an error to the console.
-
-    This function formats an error message
-    to the console, of the form:
-    @code
-    "Could not {1} because {2}."
-    @endcode
-    Where 1 is the operation which failed,
-    specified by the format arguments, and
-    2 is the reason for the failure.
-
-    @param err The error which occurred.
-
-    @param fs The operation format string.
-
-    @param arg0,args The arguments to use
-    with the format string.
-*/
-template<class... Args>
-void
-reportError(
-    Error const& err,
-    fmt::format_string<Args...> fs,
-    Args&&... args)
-{
-    MRDOX_ASSERT(err.failed());
-    reportError(fmt::format(
-        "Could not {} because {}",
-        fmt::format(fs, std::forward<Args>(args)...),
-        err.message()));
-}
-
 /** Report an unhandled exception
 */
 MRDOX_DECL
@@ -959,8 +899,6 @@ void
 reportUnhandledException(
     std::exception const& ex);
 
-//------------------------------------------------
-
 } // mrdox
 } // clang
 

lib/-XML/XMLWriter.cpp

@@ -12,7 +12,7 @@
 
 #include "CXXTags.hpp"
 #include "XMLWriter.hpp"
-#include "Tool/ConfigImpl.hpp"
+#include "Lib/ConfigImpl.hpp"
 #include "Support/Yaml.hpp"
 #include "Support/Radix.hpp"
 #include "Support/SafeNames.hpp"

lib/-adoc/AdocGenerator.cpp

@@ -108,7 +108,7 @@ buildOne(
         return Error(errors);
 
     ex->async(
-        [ &os](Builder& builder)
+        [&os](Builder& builder)
         {
             auto pageText = builder.renderSinglePageFooter().value();
             os.write(pageText.data(), pageText.size());

lib/-adoc/Options.cpp

@@ -11,7 +11,7 @@
 
 #include "Options.hpp"
 #include "Support/Yaml.hpp"
-#include "Tool/ConfigImpl.hpp" // VFALCO This is a problem
+#include "Lib/ConfigImpl.hpp" // VFALCO This is a problem
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Support/Path.hpp>
 #include <llvm/Support/YAMLParser.h>

lib/-bitcode/BitcodeGenerator.cpp

@@ -65,17 +65,13 @@ class MultiFileBuilder
                 std::error_code ec;
                 llvm::raw_fd_ostream os(filePath, ec, fs::CD_CreateAlways);
                 if(ec)
-                {
-                    reportError(Error(ec), "open \"{}\"", filePath);
-                    return;
-                }
+                    Error(ec).Throw();
                 auto bc = writeBitcode(I);
-                if(auto ec = os.error())
-                {
-                    reportError(Error(ec), "write \"{}\"", filePath);
-                    return;
-                }
+                if((ec = os.error()))
+                    Error(ec).Throw();
                 os.write(bc.data.data(), bc.data.size());
+                if((ec = os.error()))
+                    Error(ec).Throw();
             });
 
         if constexpr(T::isRecord())

lib/AST/ASTVisitor.cpp

@@ -16,7 +16,7 @@
 #include "ParseJavadoc.hpp"
 #include "Support/Path.hpp"
 #include "Support/Debug.hpp"
-#include "Tool/Diagnostics.hpp"
+#include "Lib/Diagnostics.hpp"
 #include <mrdox/Metadata.hpp>
 #include <clang/AST/Attr.h>
 #include <clang/AST/Decl.h>

lib/AST/ASTVisitor.hpp

@@ -13,8 +13,8 @@
 #ifndef MRDOX_TOOL_AST_ASTVISITOR_HPP
 #define MRDOX_TOOL_AST_ASTVISITOR_HPP
 
-#include "Tool/ConfigImpl.hpp"
-#include "Tool/ExecutionContext.hpp"
+#include "Lib/ConfigImpl.hpp"
+#include "Lib/ExecutionContext.hpp"
 #include <mrdox/Platform.hpp>
 #include <clang/Tooling/Execution.h>
 #include <clang/Tooling/Tooling.h>

lib/AST/ParseJavadoc.cpp

@@ -271,7 +271,7 @@ visitHTMLStartTagComment(
         if(end_ - it_ < 3)
         {
             // error
-            reportError(
+            report::error(
                 "warning: invalid HTML <a> tag at {}({})",
                 files::makePosixStyle(loc.getFilename()),
                 loc.getLine());

lib/Tool/AbsoluteCompilationDatabase.cpp renamed to lib/Lib/AbsoluteCompilationDatabase.cpp

@@ -11,8 +11,8 @@
 
 #include "Support/Debug.hpp"
 #include "Support/Path.hpp"
-#include "Tool/ConfigImpl.hpp"
-#include "Tool/AbsoluteCompilationDatabase.hpp"
+#include "Lib/ConfigImpl.hpp"
+#include "Lib/AbsoluteCompilationDatabase.hpp"
 #include <fmt/format.h>
 #include <clang/Basic/LangStandard.h>
 #include <clang/Driver/Driver.h>

lib/Tool/AbsoluteCompilationDatabase.hpp renamed to lib/Lib/AbsoluteCompilationDatabase.hpp

@@ -9,7 +9,7 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "Tool/ConfigImpl.hpp"
+#include "Lib/ConfigImpl.hpp"
 #include "Support/Path.hpp"
 #include <mrdox/Support/Error.hpp>
 #include <llvm/Config/llvm-config.h>

lib/Tool/Config.cpp renamed to lib/Lib/Config.cpp

@@ -9,7 +9,7 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "Tool/ConfigImpl.hpp"
+#include "Lib/ConfigImpl.hpp"
 #include "Support/Debug.hpp"
 #include "Support/Error.hpp"
 #include "Support/Path.hpp"
@@ -83,10 +83,12 @@ ConfigImpl(
         formatError("working path \"{}\" is not absolute", workingDir_).Throw();
     settings_.workingDir = files::makeDirsy(files::normalizePath(workingDir_));
 
-    if(auto err = files::requireDirectory(addonsDir_))
-        formatError("addons path \"{}\" is not absolute", addonsDir_).Throw();
-    MRDOX_ASSERT(files::isDirsy(addonsDir_));
-    settings_.addonsDir = addonsDir_;
+    // Addons directory
+    {
+        settings_.addonsDir = files::makeAbsolute(addonsDir_).value();
+        files::requireDirectory(settings_.addonsDir).maybeThrow();
+        MRDOX_ASSERT(files::isDirsy(settings_.addonsDir));
+    }
 
     settings_.configYaml = configYaml_;
     settings_.extraYaml = extraYaml_;

lib/Tool/ConfigImpl.cpp renamed to lib/Lib/ConfigImpl.cpp

@@ -166,9 +166,11 @@ class ConfigImpl
     for calculating filenames from relative
     paths.
 
-    @param addonsDir A valid directory to determine
-    the location of the addons/ folder.
-    This must be an absolute path.
+    @param addonsDir An optional, valid directory
+    to determine the location of the addons/ folder.
+    If the path is not absolute, it will be resolved
+    relative to the current working directory of
+    the process.
 
     @param configYaml A string containing valid
     YAML which will be parsed and applied to create
@@ -210,9 +212,11 @@ createConfigFromYAML(
     directory of the process. POSIX or Windows style
     path separators are accepted.
 
-    @param addonsDir A valid directory to determine
-    the location of the addons/ folder.
-    This must be an absolute path.
+    @param addonsDir An optional, valid directory
+    to determine the location of the addons/ folder.
+    If the path is not absolute, it will be resolved
+    relative to the current working directory of
+    the process.
 
     @param extraYaml An optional string containing
     additional valid YAML which will be parsed and
@@ -247,9 +251,11 @@ loadConfigFile(
     calculating filenames from relative paths.
     This must be an absolute path.
 
-    @param addonsDir A valid directory to determine
-    the location of the addons/ folder.
-    This must be an absolute path.
+    @param addonsDir An optional, valid directory
+    to determine the location of the addons/ folder.
+    If the path is not absolute, it will be resolved
+    relative to the current working directory of
+    the process.
 
     @param configYaml A string containing valid
     YAML which will be parsed and applied to create

lib/Tool/ConfigImpl.hpp renamed to lib/Lib/ConfigImpl.hpp

@@ -9,7 +9,7 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "Tool/ConfigImpl.hpp"
+#include "Lib/ConfigImpl.hpp"
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Metadata.hpp>
 #include <mrdox/Support/Error.hpp>

lib/Tool/Corpus.cpp renamed to lib/Lib/Corpus.cpp

@@ -152,7 +152,7 @@ build(
                 auto infos = readBitcode(bitcode);
                 if(! infos)
                 {
-                    reportError(infos.error(), "read bitcode");
+                    report::error("{}: reading bitcode", infos.error());
                     GotFailure = true;
                     return;
                 }
@@ -165,7 +165,7 @@ build(
             auto merged = mergeInfos(Infos);
             if(! merged)
             {
-                reportError(toError(merged.takeError()), "merge metadata");
+                report::error("{}: merging metadata", toError(merged.takeError()));
                 GotFailure = true;
                 return;
             }

lib/Tool/CorpusImpl.cpp renamed to lib/Lib/CorpusImpl.cpp

@@ -11,8 +11,8 @@
 #ifndef MRDOX_TOOL_CORPUSIMPL_HPP
 #define MRDOX_TOOL_CORPUSIMPL_HPP
 
-#include "Tool/ConfigImpl.hpp"
-#include "Tool/ToolExecutor.hpp"
+#include "Lib/ConfigImpl.hpp"
+#include "Lib/ToolExecutor.hpp"
 #include "Support/Debug.hpp"
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Metadata.hpp>

lib/Tool/CorpusImpl.hpp renamed to lib/Lib/CorpusImpl.hpp

@@ -27,15 +27,15 @@ class Diagnostics
     std::unordered_map<std::string, bool> messages_;
 
 public:
-    void reportError(std::string s)
+    void error(std::string s)
     {
         auto result =
             messages_.emplace(std::move(s), true);
         if(result.second)
             ++errorCount_;
     }
 
-    void reportWarning(std::string s)
+    void warn(std::string s)
     {
         messages_.emplace(std::move(s), false);
     }
@@ -66,7 +66,7 @@ class Diagnostics
         {
             os << "No errors or warnings.\n";
         }
-        report::print_impl(level, s, nullptr);
+        report::print_impl(level, s);
     }
 
     void

lib/Tool/Diagnostics.hpp renamed to lib/Lib/Diagnostics.hpp

@@ -110,12 +110,6 @@ execute(
         ErrorMsg += Err.str();
     };
 
-    auto Log = [&](llvm::Twine Msg)
-    {
-        std::unique_lock<std::mutex> LockGuard(TUMutex);
-        llvm::errs() << Msg.str() << "\n";
-    };
-
     // Get a copy of the filename strings
     std::vector<std::string> Files = Compilations.getAllFiles();
 
@@ -187,7 +181,7 @@ execute(
     Context.reportEnd(reportLevel_);
 
     if(! errors.empty())
-        reportError(errors, "Could not run the tool executor");
+        return makeError(Error(errors).message());
 
     if (!ErrorMsg.empty())
         return makeError(ErrorMsg);

lib/Tool/ExecutionContext.cpp renamed to lib/Lib/ExecutionContext.cpp

@@ -226,14 +226,6 @@ call_impl(
 
 //------------------------------------------------
 
-void
-reportError(
-    std::string_view text)
-{
-    std::lock_guard<llvm::sys::Mutex> lock(reportMutex_);
-    llvm::errs() << text << '\n';
-}
-
 void
 reportUnhandledException(
     std::exception const& ex)

lib/Tool/ExecutionContext.hpp renamed to lib/Lib/ExecutionContext.hpp

@@ -30,29 +30,16 @@ R"(MrDox Test Program
 
     , extraHelp(
 R"(
-ADDONS:
-    The location of the addons directory is determined in this order:
-
-    1. The --addons command line argument if present, or
-    2. The directory containing the mrdox tool executable, otherwise
-    3. The environment variable MRDOX_ADDONS_DIR if set.
-
 EXAMPLES:
     mrdox-test .. ( compile-commands )
     mrdox-test .. --action ( "test" | "create" | "update" ) ( dir | file )...
     mrdox-test --action test friend.cpp
-    mrdox-test --format adoc compile_commands.json
 )")
 
 //
 // Common options
 //
 
-, addonsDir(
-    "addons",
-    llvm::cl::desc("The path to the addons directory."),
-    llvm::cl::cat(commonCat))
-
 , reportLevel(
     "report",
     llvm::cl::desc("The minimum reporting level (0 to 4)."),
@@ -101,7 +88,6 @@ hideForeignOptions()
 
     std::vector<llvm::cl::Option const*> ours({
         &action,
-        &addonsDir,
         std::addressof(inputPaths),
         &badOption,
         &unitOption

lib/Tool/SingleFileDB.hpp renamed to lib/Lib/SingleFileDB.hpp

@@ -39,7 +39,6 @@ class TestArgs
     llvm::cl::extrahelp         extraHelp;
 
     // Common options
-    llvm::cl::opt<std::string>  addonsDir;
     llvm::cl::opt<unsigned>     reportLevel;
 
     // Test options