move type to its own header

Author: vinniefalco

CMakeLists.txt

@@ -115,11 +115,9 @@ target_include_directories(
     PUBLIC
     "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include/>"
     "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/source/lib>" # VFALCO THIS IS HACK, FIX ASAP
-    ${LLVM_INCLUDE_DIRS} # VFALCO THIS SHOULD PROBABLY BE PRIVATE?
-    ${CLANG_INCLUDE_DIRS} # VFALCO THIS SHOULD PROBABLY BE PRIVATE?
+    ${LLVM_INCLUDE_DIRS}
+    ${CLANG_INCLUDE_DIRS}
     PRIVATE
-    #${LLVM_INCLUDE_DIRS}
-    #${CLANG_INCLUDE_DIRS}
     ${PROJECT_SOURCE_DIR}/source/lib
 )
 
@@ -137,7 +135,7 @@ target_link_libraries(
 )
 
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
-source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/include/mrdox PREFIX "" FILES ${LIB_INCLUDES})
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/include PREFIX "" FILES ${LIB_INCLUDES})
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/source/lib PREFIX "source" FILES ${LIB_SOURCES})
 
 #-------------------------------------------------

include/mrdox/ClangDocContext.hpp

@@ -0,0 +1,62 @@
+//
+// 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 (vinnie.falco@gmail.com)
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_CLANGDOCCONTEXT_HPP
+#define MRDOX_CLANGDOCCONTEXT_HPP
+
+#include "Representation.h"
+#include <clang/Tooling/Execution.h>
+#include <memory>
+#include <string>
+
+namespace clang {
+namespace mrdox {
+
+/** State information for a complete run of the tool
+*/
+struct ClangDocContext
+{
+    ClangDocContext(
+        ClangDocContext&&) = delete;
+    ClangDocContext& operator=(
+        ClangDocContext&&) = delete;
+
+    ClangDocContext();
+
+    std::unique_ptr<tooling::ToolExecutor> Executor;
+
+    tooling::ExecutionContext* ECtx;
+
+    // Name of project being documented.
+    std::string ProjectName;
+
+    // Indicates if only public declarations are documented.
+    bool PublicOnly;
+
+    // Directory for outputting generated files.
+    std::string OutDirectory;
+
+    // Directory where processed files are stored. Links
+    // to definition locations will only be generated if
+    // the file is in this dir.
+    std::string SourceRoot;     
+                                                      
+    // URL of repository that hosts code used
+    // for links to definition locations.
+    std::optional<std::string> RepositoryUrl;
+
+    Index Idx;
+};
+
+} // namespace mrdox
+} // namespace clang
+
+#endif

include/mrdox/mrdox.hpp

@@ -23,6 +23,9 @@ llvm::Expected<llvm::Twine>
 renderXML(
     llvm::StringRef fileName);
 
+//llvm::Error
+
+
 } // mrdox
 } // clang
 

source/lib/ClangDoc.h

@@ -20,8 +20,8 @@
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_CLANGDOC_H
 
 #include "Representation.h"
-
-#include "clang/Tooling/Tooling.h"
+#include <mrdox/ClangDocContext.hpp>
+#include <clang/Tooling/Tooling.h>
 
 namespace clang {
 namespace mrdox {

source/lib/ClangDocContext.cpp

@@ -0,0 +1,26 @@
+//
+// 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 (vinnie.falco@gmail.com)
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#include <mrdox/ClangDocContext.hpp>
+
+namespace clang {
+namespace mrdox {
+
+ClangDocContext::
+ClangDocContext()
+{
+    llvm::SmallString<128> SourceRootDir;
+    llvm::sys::fs::current_path(SourceRootDir);
+    SourceRoot = std::string(SourceRootDir.str());
+}
+
+} // mrdox
+} // clang

source/lib/Generators.h

@@ -16,6 +16,7 @@
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
 
 #include "Representation.h"
+#include <mrdox/ClangDocContext.hpp>
 #include "llvm/Support/Error.h"
 #include "llvm/Support/Registry.h"
 

source/lib/Mapper.h

@@ -21,6 +21,7 @@
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_MAPPER_H
 
 #include "Representation.h"
+#include <mrdox/ClangDocContext.hpp>
 #include "clang/AST/RecursiveASTVisitor.h"
 #include "clang/Tooling/Execution.h"
 

source/lib/Representation.cpp

@@ -25,6 +25,7 @@
 
 #include "Reduce.h"
 #include "Representation.h"
+#include <mrdox/ClangDocContext.hpp>
 #include "llvm/Support/Error.h"
 #include "llvm/Support/Path.h"
 
@@ -359,41 +360,5 @@ void Index::sort() {
         C.sort();
 }
 
-ClangDocContext::
-ClangDocContext()
-{
-    llvm::SmallString<128> SourceRootDir;
-    llvm::sys::fs::current_path(SourceRootDir);
-    SourceRoot = std::string(SourceRootDir.str());
-}
-
-ClangDocContext::
-ClangDocContext(
-    tooling::ExecutionContext* ECtx,
-    StringRef ProjectName,
-    bool PublicOnly,
-    StringRef OutDirectory,
-    StringRef SourceRoot,
-    StringRef RepositoryUrl)
-    : ECtx(ECtx)
-    , ProjectName(ProjectName)
-    , PublicOnly(PublicOnly)
-    , OutDirectory(OutDirectory)
-{
-    llvm::SmallString<128> SourceRootDir(SourceRoot);
-    if (SourceRoot.empty())
-    {
-        // If no SourceRoot was provided the current path is used as the default
-        llvm::sys::fs::current_path(SourceRootDir);
-    }
-    this->SourceRoot = std::string(SourceRootDir.str());
-    if (!RepositoryUrl.empty()) {
-        this->RepositoryUrl = std::string(RepositoryUrl);
-        if (!RepositoryUrl.empty() && RepositoryUrl.find("http://") != 0 &&
-            RepositoryUrl.find("https://") != 0)
-            this->RepositoryUrl->insert(0, "https://");
-    }
-}
-
-} // namespace mrdox
-} // namespace clang
+} // mrdox
+} // clang

source/lib/Representation.h

@@ -626,50 +626,6 @@ struct Index
 llvm::Expected<std::unique_ptr<Info>>
 mergeInfos(std::vector<std::unique_ptr<Info>>& Values);
 
-/** State information for a complete run of the tool
-*/
-struct ClangDocContext
-{
-    ClangDocContext(
-        ClangDocContext&&) = delete;
-    ClangDocContext& operator=(
-        ClangDocContext&&) = delete;
-
-    ClangDocContext();
-
-    ClangDocContext(
-        tooling::ExecutionContext* ECtx,
-        StringRef ProjectName,
-        bool PublicOnly,
-        StringRef OutDirectory,
-        StringRef SourceRoot,
-        StringRef RepositoryUrl);
-
-    std::unique_ptr<tooling::ToolExecutor> Executor;
-
-    tooling::ExecutionContext* ECtx;
-
-    // Name of project being documented.
-    std::string ProjectName;
-
-    // Indicates if only public declarations are documented.
-    bool PublicOnly;
-
-    // Directory for outputting generated files.
-    std::string OutDirectory;
-
-    // Directory where processed files are stored. Links
-    // to definition locations will only be generated if
-    // the file is in this dir.
-    std::string SourceRoot;     
-                                                      
-    // URL of repository that hosts code used
-    // for links to definition locations.
-    std::optional<std::string> RepositoryUrl;
-
-    Index Idx;
-};
-
 } // namespace mrdox
 } // namespace clang
 

source/tests/test_main.cpp

@@ -110,6 +110,8 @@ do_main(int argc, const char** argv)
         }
         expectedXml = xmlResult->get()->getBuffer();
 
+        ClangDocContext CDCtx;
+
         {
 #if 0
             auto Executor =