auto-generate ginkgo.hpp

Author: upsj

.github/bot-pr-format-base.sh

@@ -14,7 +14,6 @@ git config user.name "ginkgo-bot"
 
 # save scripts from develop
 cp .clang-format .pre-commit-config.yaml /tmp
-cp dev_tools/scripts/update_ginkgo_header.sh /tmp
 
 # checkout current PR head
 LOCAL_BRANCH=format-tmp-$HEAD_BRANCH
@@ -23,7 +22,6 @@ git checkout -b $LOCAL_BRANCH fork/$HEAD_BRANCH
 # restore files from develop
 cp /tmp/.clang-format .
 cp /tmp/.pre-commit-config.yaml .
-cp /tmp/update_ginkgo_header.sh dev_tools/scripts/
 
 # make base pre-commit config available
 git add .pre-commit-config.yaml

.pre-commit-config.yaml

@@ -30,10 +30,3 @@ repos:
         examples/external-lib-interfacing/external-lib-interfacing.cpp|
         core/base/workspace_aliases.hpp
       )$
-  - id: update-ginkgo-header
-    name: update ginkgo header
-    entry: dev_tools/scripts/update_ginkgo_header.sh
-    language: script
-    types: [header]
-    pass_filenames: false
-    files: ^include/ginkgo/core

CMakeLists.txt

@@ -123,6 +123,7 @@ include(cmake/build_type_helpers.cmake)
 include(cmake/build_helpers.cmake)
 include(cmake/install_helpers.cmake)
 include(cmake/compiler_features.cmake)
+include(cmake/generate_ginkgo_hpp.cmake)
 
 if(MSVC)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /bigobj")
@@ -322,6 +323,7 @@ else()
     set(GINKGO_DPCPP_MAJOR_VERSION "0")
     set(GINKGO_DPCPP_MINOR_VERSION "0")
 endif()
+ginkgo_generate_ginkgo_hpp()
 configure_file(${Ginkgo_SOURCE_DIR}/include/ginkgo/config.hpp.in
     ${Ginkgo_BINARY_DIR}/include/ginkgo/config.hpp @ONLY)
 configure_file(${Ginkgo_SOURCE_DIR}/include/ginkgo/extensions/kokkos/config.hpp.in
@@ -401,16 +403,6 @@ if(GINKGO_DEVEL_TOOLS)
                       VERBATIM)
 endif()
 
-# MacOS needs to install bash, gnu-sed, findutils and coreutils
-# format_header needs clang-format 6.0.0+
-find_program(BASH bash)
-if(NOT "${BASH}" STREQUAL "BASH-NOTFOUND" AND GINKGO_DEVEL_TOOLS)
-    add_custom_target(generate_ginkgo_header ALL
-        COMMAND ${Ginkgo_SOURCE_DIR}/dev_tools/scripts/update_ginkgo_header.sh
-        WORKING_DIRECTORY ${Ginkgo_SOURCE_DIR})
-endif()
-unset(BASH CACHE)
-
 
 # Installation
 include(cmake/information_helpers.cmake)

cmake/generate_ginkgo_hpp.cmake

@@ -0,0 +1,17 @@
+function(ginkgo_generate_ginkgo_hpp)
+    file(GLOB_RECURSE headers CONFIGURE_DEPENDS ${Ginkgo_SOURCE_DIR}/include/ginkgo/*.hpp)
+    set(GKO_PUBLIC_HEADER_CONTENTS)
+    foreach(file IN LISTS headers)
+        file(RELATIVE_PATH file ${Ginkgo_SOURCE_DIR}/include "${file}")
+        # just making sure it uses / path separators
+        file(TO_CMAKE_PATH file "${file}")
+        if((file MATCHES "^ginkgo/extensions/.*$") OR
+           (file MATCHES "^ginkgo/core/stop/residual_norm_reduction.hpp$") OR
+           (file MATCHES "^ginkgo/core/solver/.*_trs.hpp$"))
+           continue()
+        endif()
+        set(GKO_PUBLIC_HEADER_CONTENTS "${GKO_PUBLIC_HEADER_CONTENTS}#include <${file}>\n")
+    endforeach()
+    configure_file(${Ginkgo_SOURCE_DIR}/include/ginkgo/ginkgo.hpp.in
+        ${Ginkgo_BINARY_DIR}/include/ginkgo/ginkgo.hpp @ONLY)
+endfunction()

dev_tools/scripts/update_ginkgo_header.sh

@@ -54,6 +54,7 @@ function(ginkgo_doc_gen name in pdf mainpage-in)
         )
     list(APPEND doxygen_base_input
         ${PROJECT_BINARY_DIR}/include/ginkgo/config.hpp
+        ${PROJECT_BINARY_DIR}/include/ginkgo/ginkgo.hpp
         ${DIR_BASE}/include
         ${MAINPAGE}
         )
@@ -79,6 +80,7 @@ function(ginkgo_doc_gen name in pdf mainpage-in)
         )
     list(APPEND doxygen_depend
         ${PROJECT_BINARY_DIR}/include/ginkgo/config.hpp
+        ${PROJECT_BINARY_DIR}/include/ginkgo/ginkgo.hpp
         )
     if(GINKGO_DOC_GENERATE_EXAMPLES)
         list(APPEND doxygen_depend

doc/helpers.cmake

@@ -7,7 +7,6 @@
 
 
 #include <ginkgo/config.hpp>
-#PUBLIC_HEADER_PLACE_HOLDER
-
+@GKO_PUBLIC_HEADER_CONTENTS@
 
 #endif  // GKO_GINKGO_HPP_