Merge pull request #28 from aminya/pch_headers_option

aminya · Nov 22, 2021 · ecf6389 · ecf6389
2 parents 3fb2f69 + a368cb5
commit ecf6389
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,7 @@ ProjectOptions(
       # ENABLE_INCLUDE_WHAT_YOU_USE
       # ENABLE_COVERAGE
       # ENABLE_PCH
+      # PCH_HEADERS
       # ENABLE_DOXYGEN
       # ENABLE_USER_LINKER
       # ENABLE_BUILD_WITH_TIME_TRACE
@@ -95,6 +96,7 @@ It accepts the following named flags:
 
 It gets the following named parameters (each accepting multiple values):
 
+- `PCH_HEADERS`: the list of the headers to precompile
 - `MSVC_WARNINGS`: Override the defaults for the MSVC warnings
 - `CLANG_WARNINGS`: Override the defaults for the CLANG warnings
 - `GCC_WARNINGS`: Override the defaults for the GCC warnings
@@ -166,6 +168,7 @@ ProjectOptions(
       # ENABLE_INCLUDE_WHAT_YOU_USE
       # ENABLE_COVERAGE
       # ENABLE_PCH
+      # PCH_HEADERS
       # ENABLE_DOXYGEN
       # ENABLE_IPO
       # ENABLE_USER_LINKER

diff --git a/src/Index.cmake b/src/Index.cmake
@@ -19,6 +19,7 @@ include("${ProjectOptions_SRC_DIR}/SystemLink.cmake")
 # - ENABLE_COVERAGE: Enable coverage reporting for gcc/clang
 # - ENABLE_CACHE: Enable cache if available
 # - ENABLE_PCH: Enable Precompiled Headers
+# - PCH_HEADERS: the list of the headers to precompile
 # - ENABLE_CONAN: Use Conan for dependency management
 # - ENABLE_DOXYGEN: Enable doxygen doc builds of source
 # - ENABLE_IPO: Enable Interprocedural Optimization, aka Link Time Optimization (LTO)
@@ -58,7 +59,7 @@ macro(ProjectOptions)
       ENABLE_SANITIZER_THREAD
       ENABLE_SANITIZER_MEMORY)
   set(oneValueArgs MSVC_WARNINGS CLANG_WARNINGS GCC_WARNINGS)
-  set(multiValueArgs CONAN_OPTIONS)
+  set(multiValueArgs PCH_HEADERS CONAN_OPTIONS)
   cmake_parse_arguments(
     ProjectOptions
     "${options}"
@@ -143,16 +144,16 @@ macro(ProjectOptions)
 
   # Very basic PCH example
   if(${ProjectOptions_ENABLE_PCH})
-    # This sets a global PCH parameter, each project will build its own PCH, which is a good idea if any #define's change
-    #
-    # consider breaking this out per project as necessary
-    target_precompile_headers(
-      project_options
-      INTERFACE
-      <vector>
-      <string>
-      <map>
-      <utility>)
+    # This sets a global PCH parameter, each project will build its own PCH, which is a good idea
+    # if any #define's change consider breaking this out per project as necessary
+    if(NOT ProjectOptions_PCH_HEADERS)
+      set(ProjectOptions_PCH_HEADERS
+          <vector>
+          <string>
+          <map>
+          <utility>)
+    endif()
+    target_precompile_headers(project_options INTERFACE ${ProjectOptions_PCH_HEADERS})
   endif()
 
   if(${ProjectOptions_ENABLE_VCPKG})

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -29,6 +29,7 @@ ProjectOptions(
   # ENABLE_INCLUDE_WHAT_YOU_USE
   # ENABLE_COVERAGE
   # ENABLE_PCH
+  # PCH_HEADERS <Eigen/Dense> <fmt/core.h> <vector> <utility> <string> <string_view>
   # ENABLE_DOXYGEN
   # ENABLE_IPO
   # ENABLE_USER_LINKER
@@ -39,6 +40,7 @@ ProjectOptions(
   # ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
   # ENABLE_SANITIZER_THREAD
   # ENABLE_SANITIZER_MEMORY
+  # CLANG_WARNINGS "-Weverything"
 )
 # NOTE: project_options and project_warnings are defined inside ProjectOptions
 

diff --git a/test/main.cpp b/test/main.cpp
@@ -8,11 +8,11 @@
 #include <string_view>
 
 // test c libraries
-// #include <cassert>
-// #include <cctype>
-// #include <cstddef>
-// #include <cstring>
-// #include <cstdint>
+#include <cassert>
+#include <cctype>
+#include <cstddef>
+#include <cstring>
+#include <cstdint>
 
 
 int main() {