mrdox.yml file

Author: klemens-morgenstern

include/mrdox/Config.hpp

@@ -13,7 +13,12 @@
 #define MRDOX_CONFIG_HPP
 
 #include <clang/Tooling/ArgumentsAdjusters.h>
+#include <clang/Tooling/Execution.h>
 #include <llvm/ADT/Optional.h>
+#include <llvm/ADT/SmallVector.h>
+#include <llvm/ADT/StringRef.h>
+#include <memory>
+#include <source_location>
 #include <string>
 
 namespace clang {
@@ -26,10 +31,6 @@ namespace mrdox {
 */
 struct Config
 {
-    Config() = default;
-    Config(Config&&) = delete;
-    Config& operator=(Config&&) = delete;
-
     /** Adjustments to tool command line, applied during execute.
     */
     tooling::ArgumentsAdjuster ArgAdjuster;
@@ -49,11 +50,27 @@ struct Config
     // the file is in this dir.
     std::string SourceRoot;     
 
+                                                      
     // URL of repository that hosts code used
     // for links to definition locations.
     llvm::Optional<std::string> RepositoryUrl;
 
     bool IgnoreMappingFailures = false;
+
+    Config();
+    Config(Config&&) = delete;
+    Config& operator=(Config&&) = delete;
+
+public:
+    struct filter { std::vector<std::string> include, exclude; };
+
+    filter namespaces, files, entities;
+
+    std::error_code
+    load(
+        const std::string & name,
+        const std::source_location & loc =
+        std::source_location::current());
 };
 
 } // mrdox

source/lib/Config.cpp

@@ -10,9 +10,78 @@
 //
 
 #include <mrdox/Config.hpp>
+#include <llvm/Support/YAMLParser.h>
+#include <llvm/Support/YAMLTraits.h>
+
+template<>
+struct llvm::yaml::MappingTraits<
+    clang::mrdox::Config::filter>
+{
+    static void mapping(
+        IO &io, clang::mrdox::Config::filter &f)
+    {
+        io.mapOptional("include", f.include);
+        io.mapOptional("exclude", f.exclude);
+    }
+};
+
+template<>
+struct llvm::yaml::MappingTraits<
+    clang::mrdox::Config>
+{
+    static void mapping(
+        IO &io, clang::mrdox::Config &f)
+    {
+        io.mapOptional("namespaces",   f.namespaces);
+        io.mapOptional("files",        f.files);
+        io.mapOptional("entities",     f.entities);
+        io.mapOptional("project-name", f.ProjectName);
+        io.mapOptional("public-only",  f.PublicOnly);
+        io.mapOptional("output-dir",   f.OutDirectory);
+    }
+};
+
+//------------------------------------------------
 
 namespace clang {
 namespace mrdox {
 
+Config::
+Config()
+{
+    if (auto p = ::getenv("MRDOX_SOURCE_ROOT"))
+        SourceRoot = p;
+    else
+    {
+        llvm::SmallString<128> SourceRootDir;
+        llvm::sys::fs::current_path(SourceRootDir);
+        SourceRoot = SourceRootDir.c_str();
+    }
+
+    if (auto p = ::getenv("MRDOX_REPOSITORY_URL"))
+        RepositoryUrl.emplace(p);
+    else if (auto q = ::getenv("DRONE_REMOTE_URL"))
+        RepositoryUrl.emplace(q);
+}
+
+std::error_code
+Config::
+load(
+    const std::string & name,
+    const std::source_location & loc)
+{
+    auto ct = llvm::MemoryBuffer::getFile(SourceRoot + "/" + name);
+    if (!ct)
+        return ct.getError();
+
+    llvm::yaml::Input yin{**ct};
+
+    yin >> *this;
+    if ( yin.error() )
+        return yin.error();
+
+    return {};
+}
+
 } // mrdox
 } // clang

source/tool/ToolMain.cpp

@@ -69,6 +69,31 @@ OutDirectory(
     llvm::cl::init("."),
     llvm::cl::cat(ToolCategory));
 
+static
+llvm::cl::opt<std::string>
+SourceRoot(
+    "source-root", llvm::cl::desc(R"(
+Directory where processed files are stored.
+Links to definition locations will only be
+generated if the file is in this dir.)"),
+    llvm::cl::cat(ToolCategory));
+
+static
+llvm::cl::opt<std::string>
+RepositoryUrl(
+    "repository", llvm::cl::desc(R"(
+URL of repository that hosts code.
+Used for links to definition locations.)"),
+    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(
@@ -110,6 +135,8 @@ toolMain(int argc, const char** argv)
     cfg.OutDirectory = OutDirectory;
     cfg.IgnoreMappingFailures = IgnoreMappingFailures;
 
+    cfg.load(ConfigPath);
+
     // create the executor
     auto ex = std::make_unique<tooling::AllTUsToolExecutor>(
         optionsResult->getCompilations(), 0);