chore: reporting is in Error.hpp

close #363, fix #365

Author: vinniefalco

include/mrdox/Support/Error.hpp

@@ -27,9 +27,11 @@
 namespace clang {
 namespace mrdox {
 
+//------------------------------------------------
 //
 // Error
 //
+//------------------------------------------------
 
 class Exception;
 
@@ -339,6 +341,10 @@ class [[nodiscard]]
     }
 };
 
+//------------------------------------------------
+//
+// SourceLocation
+//
 //------------------------------------------------
 
 /** A source location with filename prettification.
@@ -376,6 +382,10 @@ class MRDOX_DECL
     }
 };
 
+//------------------------------------------------
+//
+// Implementation
+//
 //------------------------------------------------
 
 inline
@@ -657,6 +667,140 @@ swap(Expected& rhs) noexcept
     swap(has_error_, rhs.has_error_);
 }
 
+//------------------------------------------------
+//
+// Reporting
+//
+//------------------------------------------------
+
+/** Report an error to the console.
+
+    @param text The message contents. A newline
+    will be added automatically to the output.
+*/
+MRDOX_DECL
+void
+reportError(
+    std::string_view text);
+
+/** Format an error to the console.
+
+    @param fs The operation format string.
+
+    @param arg0,args The arguments to use
+    with the format string.
+*/
+template<class Arg0, class... Args>
+void
+reportError(
+    fmt::format_string<Arg0, Args...> fs,
+    Arg0&& arg0, Args&&... args)
+{
+    reportError(fmt::format(fs,
+        std::forward<Arg0>(arg0),
+        std::forward<Args>(args)...));
+}
+
+/** Format an error to the console.
+
+    This function formats an error message
+    to the console, of the form:
+    @code
+    "Could not {1} because {2}."
+    @endcode
+    Where 1 is the operation which failed,
+    specified by the format arguments, and
+    2 is the reason for the failure.
+
+    @param err The error which occurred.
+
+    @param fs The operation format string.
+
+    @param arg0,args The arguments to use
+    with the format string.
+*/
+template<class... Args>
+void
+reportError(
+    Error const& err,
+    fmt::format_string<Args...> fs,
+    Args&&... args)
+{
+    MRDOX_ASSERT(err.failed());
+    reportError(fmt::format(
+        "Could not {} because {}",
+        fmt::format(fs, std::forward<Args>(args)...),
+        err.message()));
+}
+
+/** Report a warning to the console.
+
+    @param text The message contents. A newline
+    will be added automatically to the output.
+*/
+MRDOX_DECL
+void
+reportWarning(
+    std::string_view text);
+
+/** Format a warning to the console.
+
+    @param fs The message format string.
+    A newline will be added automatically
+    to the output.
+
+    @param arg0,args The arguments to use
+    with the format string.
+*/
+template<class Arg0, class... Args>
+void
+reportWarning(
+    fmt::format_string<Arg0, Args...> fs,
+    Arg0&& arg0, Args&&... args)
+{
+    reportWarning(fmt::format(fs,
+        std::forward<Arg0>(arg0),
+        std::forward<Args>(args)...));
+}
+
+/** Report information to the console.
+
+    @param text The message contents. A newline
+    will be added automatically to the output.
+*/
+MRDOX_DECL
+void
+reportInfo(
+    std::string_view text);
+
+/** Format information to the console.
+
+    @param fs The message format string.
+    A newline will be added automatically
+    to the output.
+
+    @param arg0,args The arguments to use
+    with the format string.
+*/
+template<class Arg0, class... Args>
+void
+reportInfo(
+    fmt::format_string<Arg0, Args...> fs,
+    Arg0&& arg0, Args&&... args)
+{
+    reportInfo(fmt::format(fs,
+        std::forward<Arg0>(arg0),
+        std::forward<Args>(args)...));
+}
+
+/** Report an unhandled exception
+*/
+MRDOX_DECL
+[[noreturn]]
+void
+reportUnhandledException(
+    std::exception const& ex);
+
 //------------------------------------------------
 
 } // mrdox

include/mrdox/Support/Report.hpp

@@ -16,8 +16,8 @@
 #include "SinglePageVisitor.hpp"
 #include "Support/SafeNames.hpp"
 #include <mrdox/Metadata/DomMetadata.hpp>
+#include <mrdox/Support/Error.hpp>
 #include <mrdox/Support/Path.hpp>
-#include <mrdox/Support/Report.hpp>
 #include <optional>
 #include <vector>
 

source/-adoc/AdocGenerator.cpp

@@ -13,7 +13,6 @@
 #include "Support/Error.hpp"
 #include "Support/SafeNames.hpp"
 #include "AST/Bitcode.hpp"
-#include <mrdox/Support/Report.hpp>
 #include <mrdox/Support/ThreadPool.hpp>
 #include <mrdox/Metadata.hpp>
 

source/-bitcode/BitcodeGenerator.cpp

@@ -11,8 +11,8 @@
 
 #include "ParseJavadoc.hpp"
 #include <mrdox/Metadata/Javadoc.hpp>
+#include <mrdox/Support/Error.hpp>
 #include <mrdox/Support/Path.hpp>
-#include <mrdox/Support/Report.hpp>
 #include <mrdox/Support/String.hpp>
 #include <clang/AST/CommentCommandTraits.h>
 #include <clang/AST/ASTContext.h>