tidy sources

Author: vinniefalco

CMakeLists.txt

@@ -16,7 +16,6 @@
 
 cmake_minimum_required(VERSION 3.13)
 cmake_policy(SET CMP0111 OLD)
-set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 project(
     MrDox
     VERSION 1.0.0
@@ -89,34 +88,27 @@ unset(CMAKE_FOLDER)
 #
 #-------------------------------------------------
 
-configure_file(source/lib/api/Version.hpp.in ${PROJECT_BINARY_DIR}/include/mrdox/Version.hpp)
-file(GLOB_RECURSE TOOL_SOURCES CONFIGURE_DEPENDS source/tool/*.cpp source/tool/*.hpp)
-file(GLOB_RECURSE LIB_INCLUDES CONFIGURE_DEPENDS include/*.hpp)
-file(GLOB_RECURSE LIB_SOURCES CONFIGURE_DEPENDS
-    source/lib/*.h
-    source/lib/*.hpp
-    source/lib/*.cpp
-    source/lib/*.natvis
-)
-
-add_executable(mrdox ${TOOL_SOURCES} ${LIB_INCLUDES} ${LIB_SOURCES})
+configure_file(source/Version.hpp.in "${PROJECT_SOURCE_DIR}/include/mrdox/Version.hpp")
+file(GLOB_RECURSE SOURCES CONFIGURE_DEPENDS source/*.cpp source/*.hpp source/*.in source/*.natvis)
+file(GLOB_RECURSE INCLUDES CONFIGURE_DEPENDS include/*.hpp)
 
+add_executable(mrdox ${SOURCES} ${INCLUDES})
 
 target_compile_features(mrdox PUBLIC cxx_std_20)
 target_include_directories(mrdox
     PUBLIC
     "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include/>"
     "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>"
     PRIVATE
-    "${PROJECT_SOURCE_DIR}/source/lib"
-    ${PROJECT_BINARY_DIR}/include
+    "${PROJECT_SOURCE_DIR}/source"
+    "${PROJECT_SOURCE_DIR}/include"
 )
 target_compile_definitions(
     mrdox
     PUBLIC
     ${MRDOX_LINK_MODE_DEFINITION}
     PRIVATE
-    -DMRDOX_LIB
+    -DMRDOX_TOOL
 )
 
 # LLVM
@@ -176,18 +168,12 @@ if (MRDOX_CLANG)
     )
 endif ()
 
-source_group(TREE ${PROJECT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
-source_group(TREE ${PROJECT_SOURCE_DIR}/include/mrdox PREFIX " include" FILES ${LIB_INCLUDES})
-source_group(TREE ${PROJECT_SOURCE_DIR}/source/lib/api PREFIX "api" FILES ${LIB_SOURCES})
+#-------------------------------------------------------------------------------
 
-target_include_directories(mrdox
-    PRIVATE
-    ${PROJECT_SOURCE_DIR}/source/lib
-    ${PROJECT_BINARY_DIR}/include/
-        )
-
-source_group(TREE ${PROJECT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
-source_group(TREE ${PROJECT_SOURCE_DIR}/source/tool PREFIX "source" FILES ${TOOL_SOURCES})
+set_property(GLOBAL PROPERTY USE_FOLDERS ON)
+#source_group(TREE ${PROJECT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
+source_group(TREE ${PROJECT_SOURCE_DIR}/include/mrdox PREFIX "include" FILES ${INCLUDES})
+source_group(TREE ${PROJECT_SOURCE_DIR}/source PREFIX "source" FILES ${SOURCES})
 
 #-------------------------------------------------
 #
@@ -196,13 +182,11 @@ source_group(TREE ${PROJECT_SOURCE_DIR}/source/tool PREFIX "source" FILES ${TOOL
 #-------------------------------------------------
 
 if (BUILD_TESTING)
-    file(GLOB_RECURSE TEST_SOURCES CONFIGURE_DEPENDS source/test/*.cpp source/test/*.hpp)
+    file(GLOB_RECURSE TEST_SOURCES CONFIGURE_DEPENDS source/*.cpp source/*.hpp)
     enable_testing()
     add_test(NAME mrdox-test COMMAND mrdox --action test
             "${PROJECT_SOURCE_DIR}/test-files/old-tests"
             )
-    source_group(TREE ${PROJECT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
-    source_group(TREE ${PROJECT_SOURCE_DIR}/source/test PREFIX "source" FILES ${TEST_SOURCES})
 
     if (CMAKE_EXPORT_COMPILE_COMMANDS)
         # test run
@@ -231,7 +215,6 @@ if (BUILD_TESTING)
                 ${CMAKE_CURRENT_SOURCE_DIR}/mrdox.rnc ${CMAKE_CURRENT_BINARY_DIR}/mrdox.rng
             SOURCES mrdox.rnc)
 
-
         file(GLOB_RECURSE XML_SOURCES CONFIGURE_DEPENDS test-files/*.xml)
         add_test(NAME xml-lint
                  COMMAND ${LIBXML2_XMLLINT_EXECUTABLE} --dropdtd --noout

include/mrdox/Platform.hpp

@@ -40,7 +40,7 @@ namespace mrdox {
 #elif defined(_MSC_VER)
 # define MRDOX_SYMBOL_EXPORT __declspec(dllexport)
 # define MRDOX_SYMBOL_IMPORT __declspec(dllimport)
-# if defined(MRDOX_LIB) // building library
+# if defined(MRDOX_TOOL) // building tool
 #  define MRDOX_DECL MRDOX_SYMBOL_EXPORT
 # else
 #  define MRDOX_DECL MRDOX_SYMBOL_IMPORT
@@ -49,7 +49,7 @@ namespace mrdox {
 
 // (unknown)
 #elif defined(__GNUC__)
-# if defined(MRDOX_LIB) // building library
+# if defined(MRDOX_TOOL) // building library
 #   define MRDOX_DECL
 # else
 #   define MRDOX_DECL __attribute__((visibility("default")))

include/mrdox/Version.hpp

@@ -0,0 +1,26 @@
+//
+// 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 Klemens D. Morgenstern
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_VERSION_HPP
+#define MRDOX_VERSION_HPP
+
+#include <string_view>
+
+namespace clang {
+namespace mrdox {
+
+constexpr std::string_view project_version     = "1.0.0";
+constexpr std::string_view project_name        = "MrDox";
+constexpr std::string_view project_description = "C++ Documentation Tool";
+
+} // mrdox
+} // clang
+
+#endif

source/lib/api/_XML/CXXTags.cpp renamed to source/-XML/CXXTags.cpp

@@ -13,8 +13,8 @@
 #define MRDOX_API_XML_CXXTAGS_HPP
 
 #include "XMLTags.hpp"
-#include "api/Support/Debug.hpp"
-#include "api/Support/Operator.hpp"
+#include "Support/Debug.hpp"
+#include "Support/Operator.hpp"
 #include <clang/AST/Attr.h>
 #include <mrdox/Metadata/Function.hpp>
 #include <mrdox/Metadata/Record.hpp>

source/lib/api/_XML/CXXTags.hpp renamed to source/-XML/CXXTags.hpp

@@ -11,8 +11,8 @@
 
 #include "XMLGenerator.hpp"
 #include "XMLWriter.hpp"
-#include "api/Support/Radix.hpp"
-#include "api/Support/RawOstream.hpp"
+#include "Support/Radix.hpp"
+#include "Support/RawOstream.hpp"
 #include <mrdox/Error.hpp>
 #include <mrdox/Metadata.hpp>
 

source/lib/api/_XML/XMLGenerator.cpp renamed to source/-XML/XMLGenerator.cpp

@@ -10,8 +10,8 @@
 //
 
 #include "XMLTags.hpp"
-#include "api/Support/Radix.hpp"
-#include "api/Support/Debug.hpp"
+#include "Support/Radix.hpp"
+#include "Support/Debug.hpp"
 
 namespace clang {
 namespace mrdox {

source/lib/api/_XML/XMLGenerator.hpp renamed to source/-XML/XMLGenerator.hpp

@@ -10,11 +10,11 @@
 //
 
 #include "XMLWriter.hpp"
-#include "api/ConfigImpl.hpp"
+#include "ConfigImpl.hpp"
 #include "CXXTags.hpp"
-#include "api/Support/Radix.hpp"
-#include "api/Support/SafeNames.hpp"
-#include "api/Support/Operator.hpp"
+#include "Support/Radix.hpp"
+#include "Support/SafeNames.hpp"
+#include "Support/Operator.hpp"
 #include <llvm/Support/YAMLParser.h>
 #include <llvm/Support/YAMLTraits.h>
 

source/lib/api/_XML/XMLTags.cpp renamed to source/-XML/XMLTags.cpp

@@ -13,7 +13,7 @@
 #define MRDOX_API_XML_XMLWRITER_HPP
 
 #include "XMLTags.hpp"
-#include "api/Support/YamlFwd.hpp"
+#include "Support/YamlFwd.hpp"
 #include <mrdox/Platform.hpp>
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Metadata.hpp>

source/lib/api/_XML/XMLTags.hpp renamed to source/-XML/XMLTags.hpp

@@ -13,8 +13,8 @@
 #include "AdocMultiPageWriter.hpp"
 #include "AdocPagesBuilder.hpp"
 #include "AdocSinglePageWriter.hpp"
-#include "api/Support/RawOstream.hpp"
-#include "api/Support/SafeNames.hpp"
+#include "Support/RawOstream.hpp"
+#include "Support/SafeNames.hpp"
 
 namespace clang {
 namespace mrdox {

source/lib/api/_XML/XMLWriter.cpp renamed to source/-XML/XMLWriter.cpp

@@ -10,7 +10,7 @@
 //
 
 #include "AdocMultiPageWriter.hpp"
-#include "api/Support/Debug.hpp"
+#include "Support/Debug.hpp"
 
 namespace clang {
 namespace mrdox {

source/lib/api/_XML/XMLWriter.hpp renamed to source/-XML/XMLWriter.hpp

@@ -12,7 +12,7 @@
 #define MRDOX_API_ADOC_ADOCMULTIPAGEWRITER_HPP
 
 #include "AdocWriter.hpp"
-#include "api/Support/SafeNames.hpp"
+#include "Support/SafeNames.hpp"
 #include <mrdox/Corpus.hpp>
 
 namespace clang {

source/lib/api/_adoc/AdocGenerator.cpp renamed to source/-adoc/AdocGenerator.cpp

@@ -10,7 +10,7 @@
 
 #include "AdocPagesBuilder.hpp"
 #include "AdocMultiPageWriter.hpp"
-#include "api/Support/Radix.hpp"
+#include "Support/Radix.hpp"
 #include <mrdox/Metadata.hpp>
 #include <llvm/ADT/STLExtras.h>
 #include <llvm/Support/FileSystem.h>

source/lib/api/_adoc/AdocGenerator.hpp renamed to source/-adoc/AdocGenerator.hpp

@@ -11,7 +11,7 @@
 #ifndef MRDOX_API_ADOC_ADOCPAGESBUILDER_HPP
 #define MRDOX_API_ADOC_ADOCPAGESBUILDER_HPP
 
-#include "api/Support/SafeNames.hpp"
+#include "Support/SafeNames.hpp"
 #include <mrdox/Platform.hpp>
 #include <mrdox/Corpus.hpp>
 #include <mrdox/MetadataFwd.hpp>

source/lib/api/_adoc/AdocMultiPageWriter.cpp renamed to source/-adoc/AdocMultiPageWriter.cpp

@@ -10,7 +10,7 @@
 //
 
 #include "AdocSinglePageWriter.hpp"
-#include "api/Support/Debug.hpp"
+#include "Support/Debug.hpp"
 
 namespace clang {
 namespace mrdox {

source/lib/api/_adoc/AdocMultiPageWriter.hpp renamed to source/-adoc/AdocMultiPageWriter.hpp

@@ -12,7 +12,7 @@
 #define MRDOX_API_ADOC_ADOCSINGLEPAGEWRITER_HPP
 
 #include "AdocWriter.hpp"
-#include "api/Support/SafeNames.hpp"
+#include "Support/SafeNames.hpp"
 #include <mrdox/Corpus.hpp>
 
 namespace clang {

source/lib/api/_adoc/AdocPagesBuilder.cpp renamed to source/-adoc/AdocPagesBuilder.cpp

@@ -10,9 +10,9 @@
 //
 
 #include "AdocWriter.hpp"
-#include "api/ConfigImpl.hpp"
-#include "api/Support/Debug.hpp"
-#include "api/Support/Validate.hpp"
+#include "ConfigImpl.hpp"
+#include "Support/Debug.hpp"
+#include "Support/Validate.hpp"
 #include <mrdox/Metadata.hpp>
 #include <mrdox/Metadata/Overloads.hpp>
 #include <clang/Basic/Specifiers.h>

source/lib/api/_adoc/AdocPagesBuilder.hpp renamed to source/-adoc/AdocPagesBuilder.hpp

@@ -12,8 +12,8 @@
 #ifndef MRDOX_API_ADOC_ADOCWRITER_HPP
 #define MRDOX_API_ADOC_ADOCWRITER_HPP
 
-#include "api/Support/SafeNames.hpp"
-#include "api/Support/YamlFwd.hpp"
+#include "Support/SafeNames.hpp"
+#include "Support/YamlFwd.hpp"
 #include <mrdox/Platform.hpp>
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Metadata.hpp>

source/lib/api/_adoc/AdocSinglePageWriter.cpp renamed to source/-adoc/AdocSinglePageWriter.cpp

@@ -10,8 +10,8 @@
 //
 
 #include "BitcodeGenerator.hpp"
-#include "api/Support/SafeNames.hpp"
-#include "api/AST/Bitcode.hpp"
+#include "Support/SafeNames.hpp"
+#include "AST/Bitcode.hpp"
 #include <mrdox/Error.hpp>
 #include <mrdox/Metadata.hpp>
 

source/lib/api/_adoc/AdocSinglePageWriter.hpp renamed to source/-adoc/AdocSinglePageWriter.hpp

@@ -14,10 +14,10 @@
 #include "Bitcode.hpp"
 #include "Commands.hpp"
 #include "ParseJavadoc.hpp"
-#include "api/ConfigImpl.hpp"
-#include "api/Metadata/FunctionKind.hpp"
-#include "api/Support/Path.hpp"
-#include "api/Support/Debug.hpp"
+#include "ConfigImpl.hpp"
+#include "Metadata/FunctionKind.hpp"
+#include "Support/Path.hpp"
+#include "Support/Debug.hpp"
 #include <mrdox/Metadata.hpp>
 #include <clang/AST/Attr.h>
 #include <clang/AST/Decl.h>

source/lib/api/_adoc/AdocWriter.cpp renamed to source/-adoc/AdocWriter.cpp

@@ -13,7 +13,7 @@
 #ifndef MRDOX_API_AST_ASTVISITOR_HPP
 #define MRDOX_API_AST_ASTVISITOR_HPP
 
-#include "api/ConfigImpl.hpp"
+#include "ConfigImpl.hpp"
 #include <mrdox/Reporter.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Metadata/Access.hpp>

source/lib/api/_adoc/AdocWriter.hpp renamed to source/-adoc/AdocWriter.hpp

@@ -16,7 +16,7 @@
 #include "BitcodeReader.hpp"
 #include "AnyNodeList.hpp"
 #include "DecodeRecord.hpp"
-#include "api/Support/Debug.hpp"
+#include "Support/Debug.hpp"
 
 namespace clang {
 namespace mrdox {

source/lib/api/_adoc/Asciidoc.hpp renamed to source/-adoc/Asciidoc.hpp

@@ -12,7 +12,7 @@
 #include "BitcodeReader.hpp"
 #include "AnyBlock.hpp"
 #include "DecodeRecord.hpp"
-#include "api/Support/Debug.hpp"
+#include "Support/Debug.hpp"
 
 namespace clang {
 namespace mrdox {

source/lib/api/_bitcode/BitcodeGenerator.cpp renamed to source/-bitcode/BitcodeGenerator.cpp

@@ -13,7 +13,7 @@
 #include "BitcodeWriter.hpp"
 #include "Bitcode.hpp"
 #include "ParseJavadoc.hpp"
-#include "api/Support/Debug.hpp"
+#include "Support/Debug.hpp"
 #include <mrdox/Metadata.hpp>
 #include <llvm/ADT/IndexedMap.h>
 #include <initializer_list>

source/lib/api/_bitcode/BitcodeGenerator.hpp renamed to source/-bitcode/BitcodeGenerator.hpp

@@ -9,8 +9,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "api/ConfigImpl.hpp"
-#include "api/Support/Path.hpp"
+#include "ConfigImpl.hpp"
+#include "Support/Path.hpp"
 #include <mrdox/Error.hpp>
 
 #include <llvm/Config/llvm-config.h>

source/lib/api/AST/ASTVisitor.cpp renamed to source/AST/ASTVisitor.cpp

@@ -9,10 +9,10 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "api/ConfigImpl.hpp"
-#include "api/Support/Path.hpp"
-#include "api/Support/YamlFwd.hpp"
-#include "api/Support/Debug.hpp"
+#include "ConfigImpl.hpp"
+#include "Support/Path.hpp"
+#include "Support/YamlFwd.hpp"
+#include "Support/Debug.hpp"
 #include <clang/Tooling/AllTUsExecution.h>
 #include <llvm/Support/FileSystem.h>
 #include <llvm/Support/Path.h>

source/lib/api/AST/ASTVisitor.hpp renamed to source/AST/ASTVisitor.hpp

@@ -12,7 +12,7 @@
 #ifndef MRDOX_API_CONFIGIMPL_HPP
 #define MRDOX_API_CONFIGIMPL_HPP
 
-#include "api/Support/YamlFwd.hpp"
+#include "Support/YamlFwd.hpp"
 #include <mrdox/Config.hpp>
 #include <llvm/Support/ThreadPool.h>
 #include <memory>

source/lib/api/AST/AnyBlock.hpp renamed to source/AST/AnyBlock.hpp

@@ -10,9 +10,9 @@
 //
 
 #include "CorpusImpl.hpp"
-#include "api/ConfigImpl.hpp"
-#include "api/AST/Bitcode.hpp"
-#include "api/AST/FrontendAction.hpp"
+#include "ConfigImpl.hpp"
+#include "AST/Bitcode.hpp"
+#include "AST/FrontendAction.hpp"
 #include "Metadata/Reduce.hpp"
 #include <mrdox/Error.hpp>
 #include <mrdox/Metadata.hpp>