refactor Config into impl

Author: vinniefalco

include/mrdox/Config.hpp

@@ -15,11 +15,9 @@
 #include <mrdox/Platform.hpp>
 #include <mrdox/Reporter.hpp>
 #include <clang/Tooling/ArgumentsAdjusters.h>
-#include <llvm/ADT/Optional.h>
-#include <llvm/ADT/SmallVector.h>
+#include <llvm/ADT/SmallString.h>
 #include <llvm/ADT/StringRef.h>
 #include <llvm/Support/Error.h>
-#include <llvm/Support/YAMLTraits.h>
 #include <functional>
 #include <memory>
 #include <string>
@@ -34,6 +32,8 @@ struct MappingTraits;
 namespace clang {
 namespace mrdox {
 
+class ConfigImpl;
+
 /** Configuration used to generate the Corpus and Docs
 
     This contains all the settings applied from
@@ -44,75 +44,39 @@ namespace mrdox {
 */
 class MRDOX_VISIBLE
     Config
-        : public std::enable_shared_from_this<Config>
 {
-    template<class T>
-    friend struct llvm::yaml::MappingTraits;
-
-    class Impl;
-    struct Options;
+    Config(Config const&) = delete;
+    Config& operator=(Config const&) = delete;
 
-    llvm::SmallString<0> configDir_;
+protected:
     std::string sourceRoot_;
-    std::vector<llvm::SmallString<0>> inputFileIncludes_;
-    bool verbose_ = true;
+    llvm::SmallString<0> configDir_;
     bool includePrivate_ = false;
+    bool verbose_ = true;
 
-    llvm::SmallString<0>
-    normalizePath(llvm::StringRef pathName);
-
-protected:
-    explicit Config(llvm::StringRef configDir);
+    explicit
+    Config(llvm::StringRef configDir);
 
 public:
-    MRDOX_DECL virtual ~Config() = default;
-
-    /** Return a defaulted Config using an existing directory.
+    class Options; // private, but for clang-15 bug
 
-        @param dirPath The path to the directory.
-        If this is relative, an absolute path will
-        be calculated from the current directory.
+    /** A resource for running submitted work, possibly concurrent.
     */
-    MRDOX_DECL
-    static
-    llvm::Expected<std::shared_ptr<Config>>
-    createAtDirectory(
-        llvm::StringRef dirPath);
+    class WorkGroup;
 
-    /** Return a Config loaded from the specified YAML file.
+    /** Destructor.
     */
     MRDOX_DECL
-    static
-    llvm::Expected<std::shared_ptr<Config>>
-    loadFromFile(
-        llvm::StringRef filePath);
+    virtual
+    ~Config() noexcept;
 
     //
     // VFALCO these naked data members are temporary...
     //
-
-    /** Adjustments to tool command line, applied during execute.
-    */
     tooling::ArgumentsAdjuster ArgAdjuster;
-
-    /** Name of project being documented.
-    */
-    std::string ProjectName;
-
-    // Directory for outputting generated files.
     std::string OutDirectory;
-                                                     
-    // URL of repository that hosts code used
-    // for links to definition locations.
-    llvm::Optional<std::string> RepositoryUrl;
-
     bool IgnoreMappingFailures = false;
 
-public:
-    /** A resource for running submitted work, possibly concurrent.
-    */
-    class WorkGroup;
-
     //--------------------------------------------
     //
     // Observers
@@ -157,32 +121,6 @@ class MRDOX_VISIBLE
         return includePrivate_;
     }
 
-    /** Returns true if the translation unit should be visited.
-
-        @param filePath The posix-style full path
-        to the file being processed.
-    */
-    bool
-    shouldVisitTU(
-        llvm::StringRef filePath) const noexcept;
-
-    /** Returns true if the file should be visited.
-
-        If the file is visited, then prefix is
-        set to the portion of the file path which
-        should be be removed for matching files.
-
-        @param filePath The posix-style full path
-        to the file being processed.
-
-        @param prefix The prefix which should be
-        removed from subsequent matches.
-    */
-    bool
-    shouldVisitFile(
-        llvm::StringRef filePath,
-        llvm::SmallVectorImpl<char>& prefix) const noexcept;
-
     /** Call a function for each element of a range.
 
         The function is invoked with a reference
@@ -235,42 +173,74 @@ class MRDOX_VISIBLE
         @param dirPath The directory.
     */
     MRDOX_DECL
+    virtual
     void
     setSourceRoot(
-        llvm::StringRef dirPath);
+        llvm::StringRef dirPath) = 0;
 
     /** Set the filter for including translation units.
     */
     MRDOX_DECL
+    virtual
     void
     setInputFileIncludes(
-        std::vector<std::string> const& list);
+        std::vector<std::string> const& list) = 0;
+
+    //--------------------------------------------
+    //
+    // Creation
+    //
+    //--------------------------------------------
+
+    /** Return a defaulted Config using an existing directory.
+
+        @param dirPath The path to the directory.
+        If this is relative, an absolute path will
+        be calculated from the current directory.
+    */
+    MRDOX_DECL
+    static
+    llvm::Expected<std::shared_ptr<Config>>
+    createAtDirectory(
+        llvm::StringRef dirPath);
+
+    /** Return a Config loaded from the specified YAML file.
+    */
+    MRDOX_DECL
+    static
+    llvm::Expected<std::shared_ptr<Config>>
+    loadFromFile(
+        llvm::StringRef filePath);
 };
 
 //------------------------------------------------
 
 /** A group representing possibly concurrent related tasks.
 */
-class Config::WorkGroup
+class MRDOX_VISIBLE
+    Config::WorkGroup
 {
 public:
     /** Destructor.
     */
-    ~WorkGroup();
+    MRDOX_DECL
+    ~WorkGroup() noexcept;
 
     /** Constructor.
 
         Default constructed workgroups have no
         concurrency level. Calls to post and wait
         are blocking.
     */
-    MRDOX_DECL WorkGroup() noexcept;
+    MRDOX_DECL
+    WorkGroup() noexcept;
 
     /** Constructor.
     */
+    MRDOX_DECL
     explicit
     WorkGroup(
-        std::shared_ptr<Config const> config);
+        Config const* config);
 
     /** Constructor.
     */
@@ -298,7 +268,7 @@ class Config::WorkGroup
     wait();
 
 private:
-    friend class Config::Impl;
+    friend class ConfigImpl;
 
     struct Base
     {
@@ -307,7 +277,7 @@ class Config::WorkGroup
 
     class Impl;
 
-    std::shared_ptr<Config::Impl const> config_;
+    std::shared_ptr<ConfigImpl const> config_;
     std::unique_ptr<Base> impl_;
 };
 
@@ -320,7 +290,7 @@ parallelForEach(
     Range&& range,
     UnaryFunction const& f) const
 {
-    WorkGroup wg(shared_from_this());
+    WorkGroup wg(this);
     for(auto&& element : range)
         wg.post([&f, &element]
             {

include/mrdox/Metadata/MemberType.hpp

@@ -16,6 +16,7 @@
 #include <mrdox/Metadata/Javadoc.hpp>
 #include <mrdox/Metadata/FieldType.hpp>
 #include <mrdox/Metadata/Function.hpp>
+#include <llvm/ADT/Optional.h>
 
 namespace clang {
 namespace mrdox {

source/lib/AST/ASTVisitor.cpp

@@ -16,6 +16,7 @@
 #include <mrdox/Debug.hpp>
 #include <clang/Index/USRGeneration.h>
 #include <clang/AST/RecursiveASTVisitor.h>
+#include <llvm/ADT/Optional.h>
 #include <llvm/ADT/StringExtras.h>
 #include <llvm/Support/Error.h>
 #include <llvm/Support/Path.h>

source/lib/AST/ASTVisitor.hpp

@@ -13,7 +13,7 @@
 #define MRDOX_LIB_AST_ASTVISITOR_HPP
 
 #include <mrdox/Platform.hpp>
-#include <mrdox/Config.hpp>
+#include "ConfigImpl.hpp"
 #include <mrdox/Reporter.hpp>
 #include <clang/AST/Mangle.h>
 #include <clang/AST/RecursiveASTVisitor.h>
@@ -46,7 +46,7 @@ class ASTVisitor
     };
 
     tooling::ExecutionContext& ex_;
-    Config const& config_;
+    ConfigImpl const& config_;
     Reporter& R_;
     std::unordered_map<
         clang::SourceLocation::UIntTy,
@@ -59,7 +59,7 @@ class ASTVisitor
         Config const& config,
         Reporter& R) noexcept
         : ex_(ex)
-        , config_(config)
+        , config_(dynamic_cast<ConfigImpl const&>(config))
         , R_(R)
     {
     }

source/lib/Config.cpp

@@ -9,27 +9,26 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
+#include "ConfigImpl.hpp"
 #include "Support/Path.hpp"
-#include <mrdox/Config.hpp>
 #include <mrdox/Error.hpp>
-#include <clang/Tooling/AllTUsExecution.h>
 #include <llvm/Support/FileSystem.h>
-#include <llvm/Support/MemoryBuffer.h>
 #include <llvm/Support/Path.h>
-#include <llvm/Support/ThreadPool.h>
 #include <llvm/Support/YAMLParser.h>
 #include <llvm/Support/YAMLTraits.h>
-#include <atomic>
 
 //------------------------------------------------
-
-// Options from YAML
+//
+// Options (YAML)
+//
+//------------------------------------------------
 
 namespace clang {
 namespace mrdox {
 
-struct Config::Options
+class Config::Options
 {
+public:
     struct FileFilter
     {
         std::vector<std::string> include;
@@ -69,8 +68,6 @@ struct llvm::yaml::MappingTraits<
     }
 };
 
-//------------------------------------------------
-
 namespace clang {
 namespace mrdox {
 
@@ -94,33 +91,6 @@ class Config::WorkGroup::
     llvm::ThreadPoolTaskGroup group_;
 };
 
-//------------------------------------------------
-//
-// Config::Impl
-//
-//------------------------------------------------
-
-class Config::Impl : public Config
-{
-    llvm::ThreadPool mutable threadPool_;
-    bool doAsync_ = true;
-
-    friend class WorkGroup;
-
-public:
-    explicit
-    Impl(
-        llvm::StringRef configDir)
-        : Config(configDir)
-        , threadPool_(
-            llvm::hardware_concurrency(
-                tooling::ExecutorConcurrency))
-    {
-    }
-};
-
-//------------------------------------------------
-
 Config::
 WorkGroup::
 Base::~Base() noexcept = default;
@@ -136,9 +106,11 @@ WorkGroup::
 Config::
 WorkGroup::
 WorkGroup(
-    std::shared_ptr<Config const> config)
-    : config_(std::dynamic_pointer_cast<
-        Config::Impl const>(std::move(config)))
+    Config const* config)
+    : config_(config
+        ? dynamic_cast<ConfigImpl const*>(
+            config)->shared_from_this()
+        : nullptr)
     , impl_(config_
         ? std::make_unique<Impl>(const_cast<
             llvm::ThreadPool&>(config_->threadPool_))
@@ -213,29 +185,10 @@ wait()
 }
 
 //------------------------------------------------
-
-llvm::SmallString<0>
-Config::
-normalizePath(
-    llvm::StringRef pathName)
-{
-    namespace path = llvm::sys::path;
-
-    llvm::SmallString<0> result;
-    if(! path::is_absolute(pathName))
-    {
-        result = configDir();
-        path::append(result, path::Style::posix, pathName);
-        path::remove_dots(result, true, path::Style::posix);
-    }
-    else
-    {
-        result = pathName;
-        path::remove_dots(result, true);
-        convert_to_slash(result);
-    }
-    return result;
-}
+//
+// Config
+//
+//------------------------------------------------
 
 Config::
 Config(
@@ -244,6 +197,11 @@ Config(
 {
 }
 
+Config::
+~Config() noexcept = default;
+
+//------------------------------------------------
+
 llvm::Expected<std::shared_ptr<Config>>
 Config::
 createAtDirectory(
@@ -258,7 +216,7 @@ createAtDirectory(
     path::remove_dots(s, true);
     makeDirsy(s);
     convert_to_slash(s);
-    return std::make_shared<Config::Impl>(s);
+    return std::make_shared<ConfigImpl>(s);
 }
 
 llvm::Expected<std::shared_ptr<Config>>
@@ -284,7 +242,7 @@ loadFromFile(
         return config.takeError();
 
     // Read the YAML file into Options
-    Options opt;
+    Config::Options opt;
     auto fileText = llvm::MemoryBuffer::getFile(filePath);
     if(! fileText)
         return makeError(fileText.getError().message(), " when loading file '", filePath, "' ");
@@ -304,70 +262,5 @@ loadFromFile(
     return config;
 }
 
-//------------------------------------------------
-//
-// Observers
-//
-//------------------------------------------------
-
-bool
-Config::
-shouldVisitTU(
-    llvm::StringRef filePath) const noexcept
-{
-    if(inputFileIncludes_.empty())
-        return true;
-    for(auto const& s : inputFileIncludes_)
-        if(filePath == s)
-            return true;
-    return false;
-}
-
-bool
-Config::
-shouldVisitFile(
-    llvm::StringRef filePath,
-    llvm::SmallVectorImpl<char>& prefixPath) const noexcept
-{
-    namespace path = llvm::sys::path;
-
-    llvm::SmallString<32> temp;
-    temp = filePath;
-    if(! path::replace_path_prefix(temp, sourceRoot_, "", path::Style::posix))
-        return false;
-    prefixPath.assign(sourceRoot_.begin(), sourceRoot_.end());
-    makeDirsy(prefixPath);
-    return true;
-}
-
-//------------------------------------------------
-//
-// Modifiers
-//
-//------------------------------------------------
-
-void
-Config::
-setSourceRoot(
-    llvm::StringRef dirPath)
-{
-    namespace path = llvm::sys::path;
-
-    auto temp = normalizePath(dirPath);
-    makeDirsy(temp, path::Style::posix);
-    sourceRoot_ = temp.str();
-}
-
-void
-Config::
-setInputFileIncludes(
-    std::vector<std::string> const& list)
-{
-    namespace path = llvm::sys::path;
-
-    for(auto const& s0 : list)
-        inputFileIncludes_.push_back(normalizePath(s0));
-}
-
 } // mrdox
 } // clang

source/lib/ConfigImpl.cpp

@@ -0,0 +1,114 @@
+//
+// This is a derivative work. originally part of the LLVM Project.
+// Licensed under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+// Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com)
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#include "ConfigImpl.hpp"
+#include "Support/Path.hpp"
+#include <clang/Tooling/AllTUsExecution.h>
+
+namespace clang {
+namespace mrdox {
+
+//------------------------------------------------
+//
+// ConfigImpl
+//
+//------------------------------------------------
+
+llvm::SmallString<0>
+ConfigImpl::
+normalizePath(
+    llvm::StringRef pathName)
+{
+    namespace path = llvm::sys::path;
+
+    llvm::SmallString<0> result;
+    if(! path::is_absolute(pathName))
+    {
+        result = configDir();
+        path::append(result, path::Style::posix, pathName);
+        path::remove_dots(result, true, path::Style::posix);
+    }
+    else
+    {
+        result = pathName;
+        path::remove_dots(result, true);
+        convert_to_slash(result);
+    }
+    return result;
+}
+
+ConfigImpl::
+ConfigImpl(
+    llvm::StringRef configDir)
+    : Config(configDir)
+    , threadPool_(
+        llvm::hardware_concurrency(
+            tooling::ExecutorConcurrency))
+{
+}
+
+void
+ConfigImpl::
+setSourceRoot(
+    llvm::StringRef dirPath)
+{
+    namespace path = llvm::sys::path;
+
+    auto temp = normalizePath(dirPath);
+    makeDirsy(temp, path::Style::posix);
+    sourceRoot_ = temp.str();
+}
+
+void
+ConfigImpl::
+setInputFileIncludes(
+    std::vector<std::string> const& list)
+{
+    namespace path = llvm::sys::path;
+
+    for(auto const& s0 : list)
+        inputFileIncludes_.push_back(normalizePath(s0));
+}
+
+//------------------------------------------------
+
+bool
+ConfigImpl::
+shouldVisitTU(
+    llvm::StringRef filePath) const noexcept
+{
+    if(inputFileIncludes_.empty())
+        return true;
+    for(auto const& s : inputFileIncludes_)
+        if(filePath == s)
+            return true;
+    return false;
+}
+
+bool
+ConfigImpl::
+shouldVisitFile(
+    llvm::StringRef filePath,
+    llvm::SmallVectorImpl<char>& prefixPath) const noexcept
+{
+    namespace path = llvm::sys::path;
+
+    llvm::SmallString<32> temp;
+    temp = filePath;
+    if(! path::replace_path_prefix(temp, sourceRoot_, "", path::Style::posix))
+        return false;
+    prefixPath.assign(sourceRoot_.begin(), sourceRoot_.end());
+    makeDirsy(prefixPath);
+    return true;
+}
+
+} // mrdox
+} // clang

source/lib/ConfigImpl.hpp

@@ -0,0 +1,87 @@
+//
+// This is a derivative work. originally part of the LLVM Project.
+// Licensed under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+// Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com)
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_LIB_CONFIGIMPL_HPP
+#define MRDOX_LIB_CONFIGIMPL_HPP
+
+#include <mrdox/Platform.hpp>
+#include <mrdox/Config.hpp>
+#include <llvm/Support/ThreadPool.h>
+#include <memory>
+
+namespace clang {
+namespace mrdox {
+
+class ConfigImpl
+    : public Config
+    , public std::enable_shared_from_this<ConfigImpl>
+
+{
+    std::vector<llvm::SmallString<0>> inputFileIncludes_;
+    llvm::ThreadPool mutable threadPool_;
+    bool doAsync_ = true;
+
+    friend class Config;
+    friend class Options;
+    friend class WorkGroup;
+
+    template<class T>
+    friend struct llvm::yaml::MappingTraits;
+
+    llvm::SmallString<0>
+    normalizePath(llvm::StringRef pathName);
+
+public:
+    explicit
+    ConfigImpl(
+        llvm::StringRef configDir);
+
+    void
+    setSourceRoot(
+        llvm::StringRef dirPath) override;
+
+    void
+    setInputFileIncludes(
+        std::vector<std::string> const& list) override;
+
+    //--------------------------------------------
+
+    /** Returns true if the translation unit should be visited.
+
+        @param filePath The posix-style full path
+        to the file being processed.
+    */
+    bool
+    shouldVisitTU(
+        llvm::StringRef filePath) const noexcept;
+
+    /** Returns true if the file should be visited.
+
+        If the file is visited, then prefix is
+        set to the portion of the file path which
+        should be be removed for matching files.
+
+        @param filePath The posix-style full path
+        to the file being processed.
+
+        @param prefix The prefix which should be
+        removed from subsequent matches.
+    */
+    bool
+    shouldVisitFile(
+        llvm::StringRef filePath,
+        llvm::SmallVectorImpl<char>& prefix) const noexcept;
+};
+
+} // mrdox
+} // clang
+
+#endif

source/lib/_XML/XML.hpp

@@ -16,6 +16,7 @@
 #include <mrdox/Generator.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Metadata/Javadoc.hpp>
+#include <llvm/ADT/Optional.h>
 
 namespace clang {
 namespace mrdox {

source/lib/_adoc/Asciidoc.hpp

@@ -18,6 +18,7 @@
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Generator.hpp>
 #include <mrdox/Metadata/Javadoc.hpp>
+#include <llvm/ADT/Optional.h>
 #include <llvm/ADT/StringRef.h>
 #include <llvm/Support/FileSystem.h>
 #include <llvm/Support/Path.h>

source/tests/TestMain.cpp

@@ -119,7 +119,7 @@ Instance(
     Reporter &R)
     : results_(results)
     , options_(options)
-    , wg_(config_)
+    , wg_(config_.get())
     , R_(R)
     , xmlGen_(getGenerators().find("xml"))
     , adocGen_(getGenerators().find("adoc"))