factor out nice

Author: vinniefalco

include/mrdox/Config.hpp

@@ -17,9 +17,17 @@
 #include <llvm/ADT/Optional.h>
 #include <llvm/ADT/SmallVector.h>
 #include <llvm/ADT/StringRef.h>
+#include <llvm/Support/YAMLTraits.h>
 #include <memory>
 #include <string>
 
+namespace llvm {
+namespace yaml {
+template<class T>
+struct MappingTraits;
+} // yaml
+} // llvm
+
 namespace clang {
 namespace mrdox {
 
@@ -28,8 +36,14 @@ namespace mrdox {
     This contains all the settings applied from
     the command line and the YML file (if any).
 */
-struct Config
+class Config
 {
+    template<class T>
+    friend struct llvm::yaml::MappingTraits;
+
+    std::string sourceRoot_;
+
+public:
     /** The root path from which all relative paths are calculated.
     */
     llvm::SmallString<16> configPath;
@@ -47,12 +61,7 @@ struct Config
 
     // Directory for outputting generated files.
     std::string OutDirectory;
-
-    // Directory where input files are stored. Links
-    // to definition locations will only be generated if
-    // the file is in this dir.
-    std::vector<std::string> includePaths;
-                                                      
+                                                     
     // URL of repository that hosts code used
     // for links to definition locations.
     llvm::Optional<std::string> RepositoryUrl;
@@ -64,6 +73,18 @@ struct Config
     Config(Config&&) = delete;
     Config& operator=(Config&&) = delete;
 
+    //--------------------------------------------
+    //
+    // Observers
+    //
+    //--------------------------------------------
+
+    llvm::StringRef
+    sourceRoot() const noexcept
+    {
+        return sourceRoot_;
+    }
+
     /** Returns true if the file should be skipped.
 
         If the file is not skipped, then prefixPath
@@ -75,6 +96,22 @@ struct Config
         llvm::StringRef filePath,
         llvm::SmallVectorImpl<char>& prefixPath) const noexcept;
 
+    //--------------------------------------------
+    //
+    // Modifiers
+    //
+    //--------------------------------------------
+
+    /** Set the directory where the input files are stored.
+
+        Symbol documentation will not be emitted unless
+        the corresponding source file is a child of this
+        directory.
+    */
+    llvm::Error
+    setSourceRoot(
+        llvm::StringRef dirPath);
+
 public:
     struct filter { std::vector<std::string> include, exclude; };
 

include/mrdox/Error.hpp

@@ -12,6 +12,7 @@
 #ifndef MRDOX_ERROR_HPP
 #define MRDOX_ERROR_HPP
 
+#include <mrdox/detail/nice.hpp>
 #include <llvm/ADT/StringRef.h>
 #include <llvm/Support/Error.h>
 #include <source_location>
@@ -50,6 +51,32 @@ makeError(
     std::source_location loc =
         std::source_location::current());
 
+template<class Arg0, class... Args>
+struct makeError_ : llvm::Error
+{
+    makeError_(
+        Arg0&& arg0,
+        Args&&... args,
+        std::source_location loc =
+            std::source_location::current())
+        : llvm::Error(
+            [&]
+            {
+                using detail::nice;
+                std::string temp;
+                llvm::raw_string_ostream os(temp);
+                os << nice(std::forward<Arg0>(arg0));
+                (os << ... << nice(std::forward<Args>(args)));
+                os << ' ' << nice(loc);
+                return makeError(temp, loc);
+            }())
+    {
+    }
+};
+
+template<class Arg0, class... Args>
+makeError_(Arg0&&, Args&&...) -> makeError_<Arg0, Args...>;
+
 //------------------------------------------------
 
 /** Return an Error for the given text and source location.

include/mrdox/Reporter.hpp

@@ -12,6 +12,7 @@
 #ifndef MRDOX_REPORTER_HPP
 #define MRDOX_REPORTER_HPP
 
+#include <mrdox/detail/nice.hpp>
 #include <llvm/Support/Error.h>
 #include <llvm/Support/Format.h>
 #include <llvm/Support/Mutex.h>
@@ -90,6 +91,7 @@ struct Reporter
 
         @param arg0, args The values to write.
     */
+    /** @{ */
     template<
         class E,
         class Arg0, class... Args>
@@ -100,6 +102,17 @@ struct Reporter
         Arg0&& arg0,
         Args&&... args);
 
+    template<
+        class E,
+        class Arg0, class... Args>
+    [[nodiscard]]
+    bool
+    error(
+        E& e,
+        Arg0&& arg0,
+        Args&&... args);
+    /** @} */
+
     //--------------------------------------------
 
     /** Report a unit test failure.
@@ -113,69 +126,29 @@ struct Reporter
         failed_ = true;
     }
 
-    static
-    llvm::StringRef
-    makeString(
-        std::source_location const& loc);
-
 private:
     //--------------------------------------------
 
     template<class T>
-    static bool isFailure(llvm::Expected<T>& e) noexcept
+    static bool isFailure(llvm::Expected<T>&& e) noexcept
     {
         return ! e.operator bool();
     }
 
     template<class T>
-    static bool isFailure(llvm::ErrorOr<T>& e) noexcept
+    static bool isFailure(llvm::ErrorOr<T>&& e) noexcept
     {
         return ! e.operator bool();
     }
 
-    static bool isFailure(std::error_code const& ec) noexcept
-    {
-        return ec.operator bool();
-    }
-
-    template<class T>
-    auto&& nice(T&& t) const
-    {
-        return std::forward<T>(t);
-    }
-
-    template<class T>
-    auto nice(llvm::Expected<T>& e) const
-    {
-        return nice(e.takeError());
-    }
-
-    template<class T>
-    auto nice(llvm::Expected<T>&& e) const
+    static bool isFailure(llvm::Error&& e) noexcept
     {
-        return nice(e.takeError());
-    }
-
-    template<class T>
-    auto nice(llvm::ErrorOr<T>& e) const
-    {
-        return nice(e.takeError());
-    }
-
-    template<class T>
-    auto nice(llvm::ErrorOr<T>&& e) const
-    {
-        return nice(e.getError());
-    }
-
-    auto nice(std::error_code&& ec) const
-    {
-        return ec.message();
+        return ! e.operator bool();
     }
 
-    auto nice(std::error_code const& ec) const
+    static bool isFailure(std::error_code&& ec) noexcept
     {
-        return ec.message();
+        return ec.operator bool();
     }
 
     void
@@ -202,11 +175,12 @@ print(
     Arg0&& arg,
     Args&&... args)
 {
+    using detail::nice;
     auto& temp = temp_string();
     temp.clear();
     {
         llvm::raw_string_ostream os(temp);
-        os << std::forward<Arg0>(arg);
+        os << nice(std::forward<Arg0>(arg));
         (os << ... << nice(std::forward<Args>(args)));
     }
     threadSafePrint(llvm::outs(), temp, nullptr);
@@ -220,12 +194,13 @@ failed(
     Arg0&& arg,
     Args&&... args)
 {
+    using detail::nice;
     auto& temp = temp_string();
     temp.clear();
     {
         llvm::raw_string_ostream os(temp);
         os << "error: Couldn't ";
-        os << std::forward<Arg0>(arg);
+        os << nice(std::forward<Arg0>(arg));
         (os << ... << nice(std::forward<Args>(args)));
         os << ".";
     }
@@ -239,25 +214,41 @@ bool
 Reporter::
 error(
     E&& e,
-    Arg0&& arg,
+    Arg0&& arg0,
     Args&&... args)
 {
-    if(! isFailure(e))
+    using detail::nice;
+    if(! isFailure(std::forward<E>(e)))
         return false;
     auto& temp = temp_string();
     temp.clear();
     {
         llvm::raw_string_ostream os(temp);
         os << "error: Couldn't ";
-        os << std::forward<Arg0>(arg);
+        os << nice(std::forward<Arg0>(arg0));
         (os << ... << nice(std::forward<Args>(args)));
-        os << " because " <<
-            nice(std::move(e)) << '.';
+        os << " because " << nice(std::forward<E>(e)) << '.';
     }
     threadSafePrint(llvm::errs(), temp, &errorCount_);
     return true;
 }
 
+template<
+    class E,
+    class Arg0, class... Args>
+bool
+Reporter::
+error(
+    E& e,
+    Arg0&& arg0,
+    Args&&... args)
+{
+    return error(
+        std::move(e),
+        std::forward<Arg0>(arg0),
+        std::forward<Args>(args)...);
+}
+
 } // mrdox
 } // clang
 

include/mrdox/detail/nice.hpp

@@ -0,0 +1,58 @@
+//
+// 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 ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_DETAIL_FORMATTER_HPP
+#define MRDOX_DETAIL_FORMATTER_HPP
+
+#include <llvm/Support/Error.h>
+#include <source_location>
+#include <system_error>
+
+namespace clang {
+namespace mrdox {
+namespace detail {
+
+template<class T>
+T& nice(T& t)
+{
+    return t;
+}
+
+template<class T>
+T&& nice(T&& t)
+{
+    return std::forward<T>(t);
+}
+
+template<class T>
+auto nice(llvm::Expected<T>&& e)
+{
+    return nice(e.takeError());
+}
+
+inline auto nice(std::error_code ec)
+{
+    return ec.message();
+}
+
+template<class T>
+auto nice(llvm::ErrorOr<T>&& e)
+{
+    return nice(e.getError());
+}
+
+llvm::StringRef nice(std::source_location loc);
+
+} // detail
+} // mrdox
+} // clang
+
+#endif