refactor corpus and error handling

Author: vinniefalco

CMakeLists.txt

@@ -133,15 +133,15 @@ source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/source/lib PREFIX "source" FILES $
 #-------------------------------------------------
 
 file(GLOB_RECURSE TOOL_SOURCES CONFIGURE_DEPENDS
-    source/mrdox/*.cpp
-    source/mrdox/*.hpp)
+    source/tool/*.cpp
+    source/tool/*.hpp)
 
 add_executable(mrdox ${TOOL_SOURCES})
 target_link_libraries(mrdox PRIVATE mrdox_lib)
-target_include_directories(mrdox PRIVATE ${PROJECT_SOURCE_DIR}/source/mrdox)
+target_include_directories(mrdox PRIVATE ${PROJECT_SOURCE_DIR}/source/tool)
 
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
-source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/source/mrdox PREFIX "" FILES ${TOOL_SOURCES})
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/source/tool PREFIX "" FILES ${TOOL_SOURCES})
 
 #-------------------------------------------------
 #
@@ -161,4 +161,4 @@ add_test(NAME mrdox_tests_bare COMMAND mrdox_tests "${CMAKE_CURRENT_SOURCE_DIR}/
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/source/tests PREFIX "" FILES ${TEST_SOURCES})
 
-#-------------------------------------------------
+#-------------------------------------------------

NOTES.adoc

@@ -2,7 +2,6 @@
 
 This worked for me:
 
-```
 # From Administrator CMD.EXE,
 # after running vcvars64.bat
 
@@ -14,6 +13,3 @@ cmake --install . --prefix "C:\Users\vinnie\src\llvm-install\Debug" --config Deb
 
 # MrDox
 cmake -G "Visual Studio 17 2022" -A x64 -B bin64 -DCMAKE_PREFIX_PATH="C:\Users\vinnie\src\llvm-install\RelWithDebInfo" -DCMAKE_TOOLCHAIN_FILE="C:\Users\vinnie\src\mrdox\toolchain.cmake"
-```
-cmake --build . --config RelWithDebInfo
-cmake --install . --prefix path\to\install\RelWithDebInfo" --config RelWithDebInfo

include/mrdox/Config.hpp

@@ -39,8 +39,6 @@ struct Config
 
     tooling::ArgumentsAdjuster ArgAdjuster;
 
-    tooling::ExecutionContext* ECtx;
-
     // Name of project being documented.
     std::string ProjectName;
 
@@ -64,37 +62,6 @@ struct Config
     std::unique_ptr<Generator> G;
 };
 
-//------------------------------------------------
-
-/** Set up a docs context from command line arguments.
-*/
-llvm::Error
-setupConfig(
-    Config& cfg,
-    int argc, const char** argv);
-
-/** Set up a docs context from command line arguments.
-*/
-llvm::Error
-setupConfig(
-    Config& cfg,
-    llvm::SmallVector<llvm::StringRef, 16> const& args);
-
-llvm::Error
-doMapping(
-    Corpus& corpus,
-    Config const& cfg);
-
-/** Build the internal index of the program under analysis.
-
-    This must happen before generating docs.
-*/
-llvm::Error
-buildIndex(
-    Corpus& corpus,
-    tooling::ToolResults& toolResults,
-    Config const& cfg);
-
 } // mrdox
 } // clang
 

include/mrdox/Corpus.hpp

@@ -13,6 +13,7 @@
 #define MRDOX_CORPUS_HPP
 
 #include "jad/Index.hpp"
+#include <mrdox/Config.hpp>
 #include <clang/Tooling/Execution.h>
 
 namespace clang {
@@ -26,7 +27,9 @@ struct Corpus
     Corpus(Corpus const&) = delete;
     Corpus& operator=(Corpus const&) = delete;
 
-    std::unique_ptr<tooling::ToolExecutor> executor;
+    // In ToolResults, the Key is the hashed USR and the value is the
+    // bitcode-encoded representation of the Info object.
+    tooling::InMemoryToolResults toolResults;
 
     Index Idx;
 
@@ -39,6 +42,27 @@ struct Corpus
         std::unique_ptr<mrdox::Info>> USRToInfo;
 };
 
+/*
+llvm::Expected<Corpus>
+buildCorpus(
+    Config const& config
+    Reporter& R);
+*/
+
+llvm::Error
+doMapping(
+    Corpus& corpus,
+    Config const& cfg);
+
+/** Build the internal index of the program under analysis.
+
+    This must happen before generating docs.
+*/
+llvm::Error
+buildIndex(
+    Corpus& corpus,
+    Config const& cfg);
+
 } // mrdox
 } // clang
 

include/mrdox/ErrorCode.hpp

@@ -0,0 +1,120 @@
+//
+// 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_ERRORCODE_HPP
+#define MRDOX_ERRORCODE_HPP
+
+#include <mrdox/detail/access.hpp>
+#include <llvm/Support/Error.h>
+#include <llvm/Support/raw_ostream.h>
+#include <source_location>
+#include <system_error>
+
+namespace clang {
+namespace mrdox {
+
+//------------------------------------------------
+
+namespace detail {
+CONST_FUNCTION_ACCESS(callGetPtr, llvm::Error, getPtr, llvm::ErrorInfoBase*);
+} // detail
+
+/** Holds a portable error code
+*/
+class ErrorCode
+{
+    std::error_code ec_;
+    std::source_location loc_;
+
+    static
+    llvm::ErrorInfoBase const*
+    getPtr(llvm::Error const& e) noexcept
+    {
+        return access::callFunction<detail::callGetPtr>(e);
+    }
+
+    static
+    std::error_code
+    getErrorCode(
+        llvm::Error const& e) noexcept
+    {
+        auto const p = getPtr(e);
+        if(! p)
+            return std::error_code();
+        return p->convertToErrorCode();
+    }
+
+public:
+    ErrorCode() = default;
+    ErrorCode(ErrorCode const&) = default;
+    ErrorCode& operator=(ErrorCode const&) = default;
+
+    ErrorCode(
+        llvm::Error& e,
+        std::source_location const& loc = 
+            std::source_location::current()) noexcept
+        : ec_(getErrorCode(e))
+        , loc_(loc)
+    {
+        e.operator bool();
+    }
+
+    ErrorCode(
+        llvm::Error&& e,
+        std::source_location const& loc = 
+            std::source_location::current()) noexcept
+        : ec_(getErrorCode(e))
+        , loc_(loc)
+    {
+        llvm::Error e_(std::move(e));
+        e_.operator bool();
+    }
+
+    std::string
+    message() const
+    {
+        return ec_.message();
+    }
+
+    std::source_location const&
+    where() const noexcept
+    {
+        return loc_;
+    }
+
+    bool failed() const noexcept
+    {
+        return ec_.operator bool();
+    }
+
+    operator bool() const noexcept
+    {
+        return failed();
+    }
+
+    friend
+    llvm::raw_ostream&
+    operator<<(
+        llvm::raw_ostream& os,
+        ErrorCode const& ec)
+    {
+        ec.write(os);
+        return os;
+    }
+
+private:
+    void write(llvm::raw_ostream& os) const;
+};
+
+} // mrdox
+} // clang
+
+#endif

source/lib/CorpusVisitor.cpp include/mrdox/Result.hpp

@@ -9,18 +9,15 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "CorpusVisitor.hpp"
+#ifndef MRDOX_RESULT_HPP
+#define MRDOX_RESULT_HPP
 
 namespace clang {
 namespace mrdox {
 
-void
-CorpusVisitor::
-reportResult(
-    StringRef Key, StringRef Value)
-{
-    cfg_.ECtx->reportResult(Key, Value);
-}
+//------------------------------------------------
 
 } // mrdox
 } // clang
+
+#endif

include/mrdox/BasicVisitor.hpp include/mrdox/Visitor.hpp

@@ -17,30 +17,32 @@
 // key is the declaration's USR and the value is the serialized bitcode.
 //
 
-#ifndef MRDOX_BASIC_VISITOR_HPP
-#define MRDOX_BASIC_VISITOR_HPP
+#ifndef MRDOX_VISITOR_HPP
+#define MRDOX_VISITOR_HPP
 
 #include "Representation.h"
 #include <mrdox/Config.hpp>
+#include <mrdox/Corpus.hpp>
 #include <clang/AST/ASTConsumer.h>
 #include <clang/AST/RecursiveASTVisitor.h>
 #include <utility>
 
 namespace clang {
 namespace mrdox {
 
-class BasicVisitor
-    : public RecursiveASTVisitor<BasicVisitor>
+class Visitor
+    : public RecursiveASTVisitor<Visitor>
     , public ASTConsumer
 {
-protected:
+    Corpus& corpus_;
     Config const& cfg_;
 
 public:
-    explicit
-    BasicVisitor(
+    Visitor(
+        Corpus& corpus,
         Config const& cfg) noexcept
-        : cfg_(cfg)
+        : corpus_(corpus)
+        , cfg_(cfg)
     {
     }
 
@@ -55,7 +57,7 @@ class BasicVisitor
     bool VisitTypeAliasDecl(TypeAliasDecl const* D);
 
 private:
-    virtual void reportResult(StringRef Key, StringRef Value) = 0;
+    void reportResult(StringRef Key, StringRef Value);
 
     template <typename T>
     bool mapDecl(T const* D);