chore: ToolExecutor refactoring

Author: vinniefalco

include/mrdox/Support/Error.hpp

@@ -96,7 +96,14 @@ class [[nodiscard]] MRDOX_DECL
         source_location loc =
             source_location::current());
 
-    explicit
+    /** Constructor.
+
+        This constructs a new error from a list
+        of zero or more errors. If the list is empty,
+        or if all of the errors in the list indicate
+        success, then newly constructed object will
+        indicate success.
+    */
     Error(
         std::vector<Error> const& errors,
         source_location loc =

source/Tool/GenerateAction.cpp

@@ -9,11 +9,11 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "ToolArgs.hpp"
 #include "ConfigImpl.hpp"
 #include "CorpusImpl.hpp"
+#include "ToolArgs.hpp"
+#include "ToolExecutor.hpp"
 #include "AST/AbsoluteCompilationDatabase.hpp"
-#include "AST/ToolExecutor.hpp"
 #include <mrdox/Generators.hpp>
 #include <mrdox/Support/Report.hpp>
 #include <mrdox/Support/Path.hpp>

source/Tool/TestAction.cpp

@@ -8,10 +8,11 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "SingleFileDB.hpp"
-#include "ToolArgs.hpp"
 #include "ConfigImpl.hpp"
 #include "CorpusImpl.hpp"
+#include "SingleFileDB.hpp"
+#include "ToolArgs.hpp"
+#include "ToolExecutor.hpp"
 #include "Support/Error.hpp"
 #include <mrdox/Config.hpp>
 #include <mrdox/Generators.hpp>
@@ -197,7 +198,7 @@ handleFile(
     std::unique_ptr<Corpus> corpus;
     {
         SingleFileDB db(dirPath, filePath);
-        tooling::StandaloneToolExecutor ex(db, { std::string(filePath) });
+        ToolExecutor ex(*config, db);
         auto result = CorpusImpl::build(ex, config);
         if(! result)
         {

source/AST/ToolExecutor.cpp renamed to source/Tool/ToolExecutor.cpp

@@ -10,6 +10,7 @@
 //
 
 #include "ToolExecutor.hpp"
+#include <mrdox/Support/Report.hpp>
 #include <mrdox/Support/ThreadPool.hpp>
 #include <clang/Tooling/ToolExecutorPluginRegistry.h>
 #include <llvm/Support/Regex.h>
@@ -112,49 +113,75 @@ execute(
         llvm::errs() << Msg.str() << "\n";
     };
 
-    auto Files = Compilations.getAllFiles();
+    // Get a copy of the filename strings
+    std::vector<std::string> Files = Compilations.getAllFiles();
 
     // Add a counter to track the progress.
-    const std::string TotalNumStr = std::to_string(Files.size());
+    auto const TotalNumStr = std::to_string(Files.size());
     unsigned Counter = 0;
     auto Count = [&]()
     {
         std::unique_lock<std::mutex> LockGuard(TUMutex);
         return ++Counter;
     };
 
-    auto& Action = Actions.front();
+    auto const& Action = Actions.front();
 
-    TaskGroup taskGroup(config_.threadPool());
+    auto const processFile =
+    [&](std::string Path)
+    {
+        if(config_.verboseOutput)
+            Log("[" + std::to_string(Count()) + "/" + TotalNumStr + "] Processing file " + Path);
+
+        // Each thread gets an independent copy of a VFS to allow different
+        // concurrent working directories.
+        IntrusiveRefCntPtr<llvm::vfs::FileSystem> FS =
+            llvm::vfs::createPhysicalFileSystem();
+
+        tooling::ClangTool Tool( Compilations, { Path },
+            std::make_shared<PCHContainerOperations>(), FS);
+        Tool.appendArgumentsAdjuster(Action.second);
+        Tool.appendArgumentsAdjuster(getDefaultArgumentsAdjusters());
+
+        for (const auto& FileAndContent : OverlayFiles)
+            Tool.mapVirtualFile(FileAndContent.first(),
+                FileAndContent.second);
+
+        // VFALCO This needs to be tested
+        if (Tool.run(Action.first.get()))
+            AppendError(llvm::Twine("Failed to run action on ") + Path + "\n");
+    };
 
-    for (std::string File : Files)
+    // Run the action on all files in the database
+    std::vector<Error> errors;
+    if(Files.size() > 1)
+    {
+        TaskGroup taskGroup(config_.threadPool());
+        // VFALCO is File move-constructed?
+        for(std::string File : std::move(Files))
+        {
+            taskGroup.async(
+            [&, Path = std::move(File)]()
+            {
+                processFile(std::move(Path));
+            });
+        }
+        errors = taskGroup.wait();
+    }
+    else
     {
-        taskGroup.async(
-        [&, Path = std::move(File)]()
+        try
+        {
+            processFile(std::move(Files.front()));
+        }
+        catch(Exception const& ex)
         {
-            if(config_.verboseOutput)
-                Log("[" + std::to_string(Count()) + "/" + TotalNumStr + "] Processing file " + Path);
-
-            // Each thread gets an independent copy of a VFS to allow different
-            // concurrent working directories.
-            IntrusiveRefCntPtr<llvm::vfs::FileSystem> FS =
-                llvm::vfs::createPhysicalFileSystem();
-
-            tooling::ClangTool Tool( Compilations, { Path },
-                std::make_shared<PCHContainerOperations>(), FS);
-            Tool.appendArgumentsAdjuster(Action.second);
-            Tool.appendArgumentsAdjuster(getDefaultArgumentsAdjusters());
-
-            for (const auto& FileAndContent : OverlayFiles)
-                Tool.mapVirtualFile(FileAndContent.first(),
-                    FileAndContent.second);
-
-            if (Tool.run(Action.first.get()))
-                AppendError(llvm::Twine("Failed to run action on ") + Path + "\n");
-        });
+            errors.push_back(ex.error());
+        }
     }
 
-    auto errors = taskGroup.wait();
+    if(! errors.empty())
+        reportError(errors, "Could not run the tool executor");
 
     if (!ErrorMsg.empty())
         return make_string_error(ErrorMsg);

source/AST/ToolExecutor.hpp renamed to source/Tool/ToolExecutor.hpp

@@ -9,8 +9,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#ifndef MRDOX_TOOL_AST_EXECUTION_HPP
-#define MRDOX_TOOL_AST_EXECUTION_HPP
+#ifndef MRDOX_TOOL_TOOL_TOOLEXECUTOR_HPP
+#define MRDOX_TOOL_TOOL_TOOLEXECUTOR_HPP
 
 #include <mrdox/Config.hpp>
 #include <clang/Tooling/ArgumentsAdjusters.h>