mrdox has a version to print

Closes #24.

Author: klemens-morgenstern

CMakeLists.txt

@@ -89,6 +89,8 @@ unset(CMAKE_FOLDER)
 #
 #-------------------------------------------------
 
+configure_file(source/api/Version.hpp.in ${PROJECT_BINARY_DIR}/include/mrdox/Version.hpp)
+
 file(GLOB_RECURSE LIB_INCLUDES CONFIGURE_DEPENDS include/*.hpp)
 file(GLOB_RECURSE LIB_SOURCES CONFIGURE_DEPENDS
     source/api/*.h
@@ -105,6 +107,7 @@ target_include_directories(mrdox-api
     "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>"
     PRIVATE
     "${PROJECT_SOURCE_DIR}/source/"
+    ${PROJECT_BINARY_DIR}/include
 )
 target_compile_definitions(
     mrdox-api
@@ -186,7 +189,9 @@ add_executable(mrdox ${TOOL_SOURCES})
 target_link_libraries(mrdox PRIVATE mrdox-api)
 target_include_directories(mrdox
     PRIVATE
-    ${PROJECT_SOURCE_DIR}/source/)
+    ${PROJECT_SOURCE_DIR}/source/
+    ${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})

source/api/Version.hpp.in

@@ -0,0 +1,34 @@
+//
+// 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 Klemens D. Morgenstern
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+#ifndef MRDOX_VERSION_HPP_IN_H
+#define MRDOX_VERSION_HPP_IN_H
+
+#include <llvm/Support/raw_ostream.h>
+
+namespace clang {
+namespace mrdox {
+
+constexpr std::string_view project_version     = "${PROJECT_VERSION}";
+constexpr std::string_view project_name        = "${PROJECT_NAME}";
+constexpr std::string_view project_description = "${PROJECT_DESCRIPTION}";
+
+inline void print_version(llvm::raw_ostream & os)
+{
+    os << project_name
+       << "\n    " << project_description
+       << "\n    version: " << project_version
+       << "\n    built with LLVM " << LLVM_VERSION_STRING;
+}
+
+}
+}
+
+#endif //MRDOX_VERSION_HPP_IN_H

source/tool/ToolMain.cpp

@@ -20,10 +20,11 @@
 //
 
 #include "api/ConfigImpl.hpp"
-#include <mrdox/Corpus.hpp>
 #include "api/Support/Debug.hpp"
+#include <mrdox/Corpus.hpp>
 #include <mrdox/Generators.hpp>
 #include <mrdox/Reporter.hpp>
+#include <mrdox/Version.hpp>
 #include <clang/Tooling/AllTUsExecution.h>
 #include <clang/Tooling/CommonOptionsParser.h>
 #include <llvm/Support/CommandLine.h>
@@ -97,6 +98,9 @@ toolMain(
 {
     auto& generators = getGenerators();
 
+    llvm::cl::SetVersionPrinter(
+            &clang::mrdox::print_version);
+
     // parse command line options
     auto optionsResult = tooling::CommonOptionsParser::create(
         argc, argv, ToolCategory, llvm::cl::OneOrMore, Overview);