more file filtering

Author: vinniefalco

README.adoc

@@ -28,5 +28,17 @@ cmake --build . -j <threads>
 cmake --install .
 ----
 
-
+=== Doxygen:
+* tries to work for many languages
+* use the inferior libclang API
+* old program with lots of technical debt
+* not written by me
+
+=== MrDox:
+* narrow and deep focus on C++ only
+* uses clang's unstable libtooling API:
+** Understands ALL C++: if clang can compile it, MrDox knows about it
+** This includes up to C++20 and even experimental things in C++23
+* brand new program with no technical debt
+* written by me
 

include/mrdox/Config.hpp

@@ -12,6 +12,7 @@
 #ifndef MRDOX_CONFIG_HPP
 #define MRDOX_CONFIG_HPP
 
+#include <mrdox/Errors.hpp>
 #include <clang/Tooling/ArgumentsAdjusters.h>
 #include <clang/Tooling/Execution.h>
 #include <llvm/ADT/Optional.h>
@@ -31,6 +32,10 @@ namespace mrdox {
 */
 struct Config
 {
+    /** The root path from which all relative paths are calculated.
+    */
+    llvm::SmallString<16> configPath;
+
     /** Adjustments to tool command line, applied during execute.
     */
     tooling::ArgumentsAdjuster ArgAdjuster;
@@ -48,7 +53,7 @@ struct Config
     // Directory where processed files are stored. Links
     // to definition locations will only be generated if
     // the file is in this dir.
-    std::vector<llvm::SmallString<0>> includePaths;
+    std::vector<std::string> includePaths;
 
     // URL of repository that hosts code used
     // for links to definition locations.
@@ -57,7 +62,7 @@ struct Config
     bool IgnoreMappingFailures = false;
 
 public:
-    Config();
+    Config() = default;
     Config(Config&&) = delete;
     Config& operator=(Config&&) = delete;
 
@@ -68,7 +73,7 @@ struct Config
         should be be removed for matching files.
     */
     bool
-    filterFile(
+    filterSourceFile(
         llvm::StringRef filePath,
         llvm::SmallVectorImpl<char>& prefixPath) const noexcept;
 
@@ -77,11 +82,10 @@ struct Config
 
     filter namespaces, files, entities;
 
-    std::error_code
-    load(
-        const std::string & name,
-        const std::source_location & loc =
-        std::source_location::current());
+    bool
+    loadFromFile(
+        llvm::StringRef filePath,
+        Reporter& R);
 };
 
 } // mrdox

source/lib/Config.cpp

@@ -10,6 +10,9 @@
 //
 
 #include <mrdox/Config.hpp>
+#include <llvm/Support/FileSystem.h>
+#include <llvm/Support/MemoryBuffer.h>
+#include <llvm/Support/Path.h>
 #include <llvm/Support/YAMLParser.h>
 #include <llvm/Support/YAMLTraits.h>
 
@@ -18,10 +21,9 @@ struct llvm::yaml::MappingTraits<
     clang::mrdox::Config::filter>
 {
     static void mapping(
-        IO &io, clang::mrdox::Config::filter &f)
+        IO &io, clang::mrdox::Config::filter& f)
     {
-        io.mapOptional("include", f.include);
-        io.mapOptional("exclude", f.exclude);
+        io.mapOptional("exclude", f);
     }
 };
 
@@ -38,6 +40,7 @@ struct llvm::yaml::MappingTraits<
         io.mapOptional("project-name", f.ProjectName);
         io.mapOptional("public-only",  f.PublicOnly);
         io.mapOptional("output-dir",   f.OutDirectory);
+        io.mapOptional("include",      f.includePaths);
     }
 };
 
@@ -46,58 +49,92 @@ struct llvm::yaml::MappingTraits<
 namespace clang {
 namespace mrdox {
 
-Config::
-Config()
-{
-    if (auto p = ::getenv("MRDOX_REPOSITORY_URL"))
-        RepositoryUrl.emplace(p);
-    else if (auto q = ::getenv("DRONE_REMOTE_URL"))
-        RepositoryUrl.emplace(q);
-}
-
 bool
 Config::
-filterFile(
+filterSourceFile(
     llvm::StringRef filePath,
     llvm::SmallVectorImpl<char>& prefixPath) const noexcept
 {
     namespace path = llvm::sys::path;
 
-    for(auto const s : includePaths)
+    llvm::SmallString<32> temp;
+    for(auto const& s : includePaths)
     {
-        if(filePath.starts_with(s))
+        temp = filePath;
+        if(path::replace_path_prefix(temp, s, ""))
         {
-            prefixPath = s;
-            if(! path::is_separator(prefixPath.back()))
-            {
-                auto const sep = path::get_separator();
-                prefixPath.insert(prefixPath.end(),
-                    sep.begin(), sep.end());
-            }
+            prefixPath.assign(s.begin(), s.end());
             return false;
         }
     }
     return true;
 }
 
-std::error_code
+// Make the path end in a separator
+static
+void
+makeDirsy(
+    llvm::SmallVectorImpl<char>& s)
+{
+    namespace path = llvm::sys::path;
+    if(! path::is_separator(s.back()))
+    {
+        auto const sep = path::get_separator();
+        s.insert(s.end(), sep.begin(), sep.end());
+    }
+}
+
+bool
 Config::
-load(
-    const std::string & name,
-    const std::source_location & loc)
+loadFromFile(
+    llvm::StringRef filePath,
+    Reporter& R)
 {
-#if 0
-    auto ct = llvm::MemoryBuffer::getFile(SourceRoot + "/" + name);
-    if (!ct)
-        return ct.getError();
+    namespace fs = llvm::sys::fs;
+    namespace path = llvm::sys::path;
 
-    llvm::yaml::Input yin{**ct};
+    // get absolute path to config file
+    configPath = filePath;
+    fs::make_absolute(configPath);
 
+    // Read the YAML file and apply to this
+    auto fileText = llvm::MemoryBuffer::getFile(configPath);
+    if(! fileText)
+    {
+        R.failed("llvm::MemoryBuffer::getFile", fileText);
+        return false;
+    }
+    llvm::yaml::Input yin(**fileText);
     yin >> *this;
-    if ( yin.error() )
-        return yin.error();
-#endif
-    return {};
+    std::error_code ec = yin.error();
+    if(ec)
+    {
+        R.failed("llvm::yaml::Input::operator>>", ec);
+        return false;
+    }
+
+    // change configPath to the directory
+    path::remove_filename(configPath);
+    path::remove_dots(configPath, true);
+
+    // make includePaths absolute
+    {
+        llvm::SmallString<128> temp;
+        for(auto& s : includePaths)
+        {
+            if(path::is_absolute(s))
+                continue;
+            temp.clear();
+            path::append(temp, configPath, s);
+            // separator at the end is required
+            // for replace_path_prefix to work
+            path::remove_dots(temp, true);
+            makeDirsy(temp);
+            s.assign(temp.begin(), temp.end());
+        }
+    }
+
+    return true;
 }
 
 } // mrdox

source/lib/Visitor.cpp

@@ -70,7 +70,7 @@ mapDecl(T const* D)
         // new element
         filePath = loc.getFilename();
         FileFilter& ff = result.first->second;
-        ff.exclude = config_.filterFile(filePath, ff.prefix);
+        ff.exclude = config_.filterSourceFile(filePath, ff.prefix);
         if(ff.exclude)
             return true;
         path::replace_path_prefix(filePath, ff.prefix, "");

source/tool/ToolMain.cpp

@@ -41,7 +41,7 @@ R"(Generates documentation from source code and comments.
 Examples
 
   $ mrdox mrdox.yml
-  $ mrdox --output ./docs mrdox.yml
+  $ mrdox --config=mrdox.yml --output ./docs
 )";
 
 static
@@ -53,6 +53,22 @@ static
 llvm::cl::OptionCategory
 ToolCategory("mrdox options");
 
+static
+llvm::cl::opt<std::string>
+    ConfigPath(
+    "config",
+    llvm::cl::desc(R"(The config filename relative to the repository root)"),
+    llvm::cl::init("mrdox.yaml"),
+    llvm::cl::cat(ToolCategory));
+
+static
+llvm::cl::opt<std::string>
+FormatType(
+    "format",
+    llvm::cl::desc("Format for outputted docs (\"adoc\" or \"xml\")."),
+    llvm::cl::init("adoc"),
+    llvm::cl::cat(ToolCategory));
+
 static
 llvm::cl::opt<bool>
     IgnoreMappingFailures(
@@ -69,22 +85,6 @@ OutDirectory(
     llvm::cl::init("."),
     llvm::cl::cat(ToolCategory));
 
-static
-llvm::cl::opt<std::string>
-    ConfigPath(
-    "config-file",
-    llvm::cl::desc(R"(The config filename relative to the repository root)"),
-    llvm::cl::init("mrdox.yaml"),
-    llvm::cl::cat(ToolCategory));
-
-static
-llvm::cl::opt<std::string>
-FormatType(
-    "format",
-    llvm::cl::desc("Format for outputted docs (\"adoc\" or \"xml\")."),
-    llvm::cl::init("adoc"),
-    llvm::cl::cat(ToolCategory));
-
 } // (anon)
 
 //------------------------------------------------
@@ -118,7 +118,8 @@ toolMain(int argc, const char** argv)
     config.OutDirectory = OutDirectory;
     config.IgnoreMappingFailures = IgnoreMappingFailures;
 
-    config.load(ConfigPath);
+    if(! config.loadFromFile(ConfigPath, R))
+        return EXIT_FAILURE;
 
     // create the executor
     auto ex = std::make_unique<tooling::AllTUsToolExecutor>(