build: optimze build (#60)

- update baseline and cmake-modules. - remove some useless cmake build instructions and optimize heaeder-only layout.
serious-scaffold · Mar 5, 2024 · b99bd6b · b99bd6b
1 parent 03afcf8
commit b99bd6b
Show file tree

Hide file tree

Showing 18 changed files with 50 additions and 84 deletions.
diff --git a/src/compile/CMakeLists.txt b/src/compile/CMakeLists.txt
@@ -12,28 +12,12 @@ target_code_coverage(${target_name}-shared ALL)
 
 include(GenerateExportHeader)
 generate_export_header(
-  ${target_name}-shared
-  BASE_NAME
-  "${target_name}"
-  EXPORT_MACRO_NAME
-  "${target_name}_EXPORT"
-  EXPORT_FILE_NAME
+  ${target_name}-shared BASE_NAME "${target_name}" EXPORT_FILE_NAME
   "${CMAKE_CURRENT_BINARY_DIR}/include/${target_name}/${target_name}_export.hpp"
-  DEPRECATED_MACRO_NAME
-  "${target_name}_DEPRECATED"
-  NO_EXPORT_MACRO_NAME
-  "${target_name}_NO_EXPORT"
-  STATIC_DEFINE
-  "${target_name}_STATIC_DEFINE"
-  NO_DEPRECATED_MACRO_NAME
-  "${target_name}_NO_DEPRECATED"
-  DEFINE_NO_DEPRECATED)
+)
 
 target_sources(${target_name}-shared PRIVATE ${_srcs} ${_hdrs})
 
-target_compile_definitions(${target_name}-shared
-                           INTERFACE $<INSTALL_INTERFACE:USING_${target_name}>)
-
 target_include_interface_directories(
   ${target_name}-shared ${CMAKE_CURRENT_BINARY_DIR}/include/${target_name}
   ${CMAKE_CURRENT_SOURCE_DIR}/include ${CMAKE_BINARY_DIR}/git/include)
@@ -62,10 +46,8 @@ target_code_coverage(${target_name}-static ALL)
 
 target_sources(${target_name}-static PRIVATE ${_srcs} ${_hdrs})
 
-target_compile_definitions(
-  ${target_name}-static
-  PUBLIC ${target_name}_STATIC_DEFINE
-  INTERFACE $<INSTALL_INTERFACE:USING_${target_name}>)
+target_compile_definitions(${target_name}-static
+                           INTERFACE ${target_name}_STATIC_DEFINE)
 
 target_include_interface_directories(
   ${target_name}-static ${CMAKE_CURRENT_BINARY_DIR}/include/${target_name}
@@ -81,11 +63,8 @@ target_link_libraries(
   PRIVATE msft_proxy
   PRIVATE absl::log)
 
-set_target_properties(
-  ${target_name}-static
-  PROPERTIES POSITION_INDEPENDENT_CODE 1
-             ARCHIVE_OUTPUT_NAME "${target_name}_s"
-             RELEASE_POSTFIX "_s")
+set_target_properties(${target_name}-static PROPERTIES ARCHIVE_OUTPUT_NAME
+                                                       "${target_name}")
 
 # msvc layout in solution
 source_group("impl" REGULAR_EXPRESSION "impl/.*\\.[h|cpp]")
@@ -116,8 +95,11 @@ install_target(
   msft_proxy
   absl::log)
 
+install_dependency(TARGETS ${target_name}-shared ${target_name}-static)
+
 # Tests
 message(STATUS "BUILD_TESTING:${BUILD_TESTING}")
+
 if(BUILD_TESTING)
   add_subdirectory(tests)
 endif()
diff --git a/src/compile/include/compile.hpp b/src/compile/include/compile.hpp
@@ -8,13 +8,12 @@ namespace info {
 /**
  * \brief Get compile version string
  * \return The distribution compile version provided.
- * \note A string "dev" will be returned when no version configuration.
  */
-std::string_view compile_EXPORT version_compile() noexcept;
+std::string_view COMPILE_EXPORT version_compile() noexcept;
 
 /**
- * \return A bool represents if debug when building.
+ * \return A bool represents if it is debug distribution.
  */
-bool compile_EXPORT is_debug() noexcept;
+bool COMPILE_EXPORT is_debug() noexcept;
 }; // namespace info
 }; // namespace compile
diff --git a/src/compile/include/impl/impl.hpp b/src/compile/include/impl/impl.hpp
@@ -15,7 +15,7 @@ namespace geo {
 // https://devblogs.microsoft.com/cppblog/proxy-runtime-polymorphism-made-easier-than-ever/
 
 // Abstraction Draw interface for polymorphic call
-struct compile_EXPORT Draw : pro::dispatch<void(std::ostream&)> {
+struct COMPILE_EXPORT Draw : pro::dispatch<void(std::ostream&)> {
 public:
     template <class T>
     void operator()(const T& self, std::ostream& out) {
@@ -24,7 +24,7 @@ struct compile_EXPORT Draw : pro::dispatch<void(std::ostream&)> {
 };
 
 // Abstraction Area interface for polymorphic call
-struct compile_EXPORT Area : pro::dispatch<double()> {
+struct COMPILE_EXPORT Area : pro::dispatch<double()> {
 public:
     template <class T>
     double operator()(const T& self) {
@@ -33,13 +33,13 @@ struct compile_EXPORT Area : pro::dispatch<double()> {
 };
 
 // Interface facade for Draw, Area
-struct compile_EXPORT DrawableFacade : pro::facade<Draw, Area> {};
+struct COMPILE_EXPORT DrawableFacade : pro::facade<Draw, Area> {};
 
 // Client API - Consumer
-std::string compile_EXPORT PrintDrawableToString(const pro::proxy<DrawableFacade>& p);
+std::string COMPILE_EXPORT PrintDrawableToString(const pro::proxy<DrawableFacade>& p);
 
 // Client API - Producer
-pro::proxy<DrawableFacade> compile_EXPORT CreateRectangleAsDrawable(int width, int height);
+pro::proxy<DrawableFacade> COMPILE_EXPORT CreateRectangleAsDrawable(int width, int height);
 
 }; // namespace geo
 }; // namespace compile
diff --git a/src/compile/src/compile.cpp b/src/compile/src/compile.cpp
@@ -1,4 +1,5 @@
 #include "compile.hpp"
+
 #include <absl/log/log.h>
 #include "git.h"
 #include "impl/impl.hpp"
@@ -9,7 +10,7 @@ std::string_view version_compile() noexcept {
     return git::ProjectVersion();
 }
 
-bool compile_EXPORT is_debug() noexcept {
+bool is_debug() noexcept {
 #ifdef _DEBUG
     return true;
 #else

diff --git a/src/compile/src/impl/impl.cpp b/src/compile/src/impl/impl.cpp
@@ -1,4 +1,5 @@
 #include "impl/impl.hpp"
+
 #include <sstream>
 
 namespace compile {

diff --git a/src/header_only/CMakeLists.txt b/src/header_only/CMakeLists.txt
@@ -16,7 +16,7 @@ install_target(
   TARGETS
   ${target_name}
   INCLUDES
-  ${CMAKE_CURRENT_SOURCE_DIR}/include/
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/${target_name}/
   ${CMAKE_BINARY_DIR}/git/include/
   LICENSE_FILE_LIST
   ${CMAKE_SOURCE_DIR}/LICENSE

diff --git a/src/header_only/include/header_only.hpp → ..._only/include/header_only/header_only.hpp b/src/header_only/include/header_only.hpp → ..._only/include/header_only/header_only.hpp
diff --git a/src/header_only/tests/test_header_only.cpp b/src/header_only/tests/test_header_only.cpp
@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "header_only.hpp"
+#include "header_only/header_only.hpp"
 
 TEST(common, some_fun) {
     const auto fun_ret = header_only::common::some_fun();

diff --git a/template/src/[% if add_compile_target == true %]compile[% endif %]/CMakeLists.txt b/template/src/[% if add_compile_target == true %]compile[% endif %]/CMakeLists.txt
@@ -12,28 +12,12 @@ target_code_coverage(${target_name}-shared ALL)
 
 include(GenerateExportHeader)
 generate_export_header(
-  ${target_name}-shared
-  BASE_NAME
-  "${target_name}"
-  EXPORT_MACRO_NAME
-  "${target_name}_EXPORT"
-  EXPORT_FILE_NAME
+  ${target_name}-shared BASE_NAME "${target_name}" EXPORT_FILE_NAME
   "${CMAKE_CURRENT_BINARY_DIR}/include/${target_name}/${target_name}_export.hpp"
-  DEPRECATED_MACRO_NAME
-  "${target_name}_DEPRECATED"
-  NO_EXPORT_MACRO_NAME
-  "${target_name}_NO_EXPORT"
-  STATIC_DEFINE
-  "${target_name}_STATIC_DEFINE"
-  NO_DEPRECATED_MACRO_NAME
-  "${target_name}_NO_DEPRECATED"
-  DEFINE_NO_DEPRECATED)
+)
 
 target_sources(${target_name}-shared PRIVATE ${_srcs} ${_hdrs})
 
-target_compile_definitions(${target_name}-shared
-                           INTERFACE $<INSTALL_INTERFACE:USING_${target_name}>)
-
 target_include_interface_directories(
   ${target_name}-shared ${CMAKE_CURRENT_BINARY_DIR}/include/${target_name}
   ${CMAKE_CURRENT_SOURCE_DIR}/include ${CMAKE_BINARY_DIR}/git/include)
@@ -62,10 +46,8 @@ target_code_coverage(${target_name}-static ALL)
 
 target_sources(${target_name}-static PRIVATE ${_srcs} ${_hdrs})
 
-target_compile_definitions(
-  ${target_name}-static
-  PUBLIC ${target_name}_STATIC_DEFINE
-  INTERFACE $<INSTALL_INTERFACE:USING_${target_name}>)
+target_compile_definitions(${target_name}-static
+                           INTERFACE ${target_name}_STATIC_DEFINE)
 
 target_include_interface_directories(
   ${target_name}-static ${CMAKE_CURRENT_BINARY_DIR}/include/${target_name}
@@ -81,11 +63,8 @@ target_link_libraries(
   PRIVATE msft_proxy
   PRIVATE absl::log)
 
-set_target_properties(
-  ${target_name}-static
-  PROPERTIES POSITION_INDEPENDENT_CODE 1
-             ARCHIVE_OUTPUT_NAME "${target_name}_s"
-             RELEASE_POSTFIX "_s")
+set_target_properties(${target_name}-static PROPERTIES ARCHIVE_OUTPUT_NAME
+                                                       "${target_name}")
 
 # msvc layout in solution
 source_group("impl" REGULAR_EXPRESSION "impl/.*\\.[h|cpp]")
@@ -116,8 +95,11 @@ install_target(
   msft_proxy
   absl::log)
 
+install_dependency(TARGETS ${target_name}-shared ${target_name}-static)
+
 # Tests
 message(STATUS "BUILD_TESTING:${BUILD_TESTING}")
+
 if(BUILD_TESTING)
   add_subdirectory(tests)
 endif()
diff --git a/template/src/[% if add_compile_target == true %]compile[% endif %]/include/compile.hpp b/template/src/[% if add_compile_target == true %]compile[% endif %]/include/compile.hpp
@@ -8,13 +8,12 @@ namespace info {
 /**
  * \brief Get compile version string
  * \return The distribution compile version provided.
- * \note A string "dev" will be returned when no version configuration.
  */
-std::string_view compile_EXPORT version_compile() noexcept;
+std::string_view COMPILE_EXPORT version_compile() noexcept;
 
 /**
- * \return A bool represents if debug when building.
+ * \return A bool represents if it is debug distribution.
  */
-bool compile_EXPORT is_debug() noexcept;
+bool COMPILE_EXPORT is_debug() noexcept;
 }; // namespace info
 }; // namespace compile
diff --git a/template/src/[% if add_compile_target == true %]compile[% endif %]/include/impl/impl.hpp b/template/src/[% if add_compile_target == true %]compile[% endif %]/include/impl/impl.hpp
@@ -15,7 +15,7 @@ namespace geo {
 // https://devblogs.microsoft.com/cppblog/proxy-runtime-polymorphism-made-easier-than-ever/
 
 // Abstraction Draw interface for polymorphic call
-struct compile_EXPORT Draw : pro::dispatch<void(std::ostream&)> {
+struct COMPILE_EXPORT Draw : pro::dispatch<void(std::ostream&)> {
 public:
     template <class T>
     void operator()(const T& self, std::ostream& out) {
@@ -24,7 +24,7 @@ struct compile_EXPORT Draw : pro::dispatch<void(std::ostream&)> {
 };
 
 // Abstraction Area interface for polymorphic call
-struct compile_EXPORT Area : pro::dispatch<double()> {
+struct COMPILE_EXPORT Area : pro::dispatch<double()> {
 public:
     template <class T>
     double operator()(const T& self) {
@@ -33,13 +33,13 @@ struct compile_EXPORT Area : pro::dispatch<double()> {
 };
 
 // Interface facade for Draw, Area
-struct compile_EXPORT DrawableFacade : pro::facade<Draw, Area> {};
+struct COMPILE_EXPORT DrawableFacade : pro::facade<Draw, Area> {};
 
 // Client API - Consumer
-std::string compile_EXPORT PrintDrawableToString(const pro::proxy<DrawableFacade>& p);
+std::string COMPILE_EXPORT PrintDrawableToString(const pro::proxy<DrawableFacade>& p);
 
 // Client API - Producer
-pro::proxy<DrawableFacade> compile_EXPORT CreateRectangleAsDrawable(int width, int height);
+pro::proxy<DrawableFacade> COMPILE_EXPORT CreateRectangleAsDrawable(int width, int height);
 
 }; // namespace geo
 }; // namespace compile
diff --git a/template/src/[% if add_compile_target == true %]compile[% endif %]/src/compile.cpp b/template/src/[% if add_compile_target == true %]compile[% endif %]/src/compile.cpp
@@ -1,4 +1,5 @@
 #include "compile.hpp"
+
 #include <absl/log/log.h>
 #include "git.h"
 #include "impl/impl.hpp"
@@ -9,7 +10,7 @@ std::string_view version_compile() noexcept {
     return git::ProjectVersion();
 }
 
-bool compile_EXPORT is_debug() noexcept {
+bool is_debug() noexcept {
 #ifdef _DEBUG
     return true;
 #else

diff --git a/template/src/[% if add_compile_target == true %]compile[% endif %]/src/impl/impl.cpp b/template/src/[% if add_compile_target == true %]compile[% endif %]/src/impl/impl.cpp
@@ -1,4 +1,5 @@
 #include "impl/impl.hpp"
+
 #include <sstream>
 
 namespace compile {

diff --git a/template/src/[% if add_header_only_target == true %]header_only[% endif %]/CMakeLists.txt b/template/src/[% if add_header_only_target == true %]header_only[% endif %]/CMakeLists.txt
@@ -16,7 +16,7 @@ install_target(
   TARGETS
   ${target_name}
   INCLUDES
-  ${CMAKE_CURRENT_SOURCE_DIR}/include/
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/${target_name}/
   ${CMAKE_BINARY_DIR}/git/include/
   LICENSE_FILE_LIST
   ${CMAKE_SOURCE_DIR}/LICENSE

diff --git a/...r_only[% endif %]/include/header_only.hpp → ...if %]/include/header_only/header_only.hpp b/...r_only[% endif %]/include/header_only.hpp → ...if %]/include/header_only/header_only.hpp
diff --git a/...[% if add_header_only_target == true %]header_only[% endif %]/tests/test_header_only.cpp b/...[% if add_header_only_target == true %]header_only[% endif %]/tests/test_header_only.cpp
@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "header_only.hpp"
+#include "header_only/header_only.hpp"
 
 TEST(common, some_fun) {
     const auto fun_ret = header_only::common::some_fun();

diff --git a/template/vcpkg.json.jinja b/template/vcpkg.json.jinja
@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json",
   "name": "{{ repo_name }}",
   "description": "{{ project_description }}",
-  "builtin-baseline": "80403036a665cb8fcc1a1b3e17593d20b03b2489",
+  "builtin-baseline": "710677da49b03885c65c8b5ca43072d4b1acde75",
   "dependencies": [
 [%- if add_compile_target == true or add_executable_target == true or add_header_only_target == true %]
     "abseil",
@@ -46,7 +46,7 @@
 [%- endif %]
     {
       "name": "cmake-modules",
-      "version": "1.3.0"
+      "version": "1.3.6"
     },
     {
       "name": "robotology-cmake-ycm",
@@ -57,7 +57,7 @@
     "registries": [
       {
         "kind": "git",
-        "baseline": "b58077c46126bee7c5cd54c26a4b974055c21d2b",
+        "baseline": "8166fd34bde37098afa04b82b0ec7f2a2f467fe3",
         "repository": "https://github.com/msclock/cmake-registry",
         "packages": [
 [%- if use_conan == true %]

diff --git a/vcpkg.json b/vcpkg.json
@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json",
   "name": "ss-cpp",
   "description": "A development-focused Cpp project template.",
-  "builtin-baseline": "80403036a665cb8fcc1a1b3e17593d20b03b2489",
+  "builtin-baseline": "710677da49b03885c65c8b5ca43072d4b1acde75",
   "dependencies": [
     "abseil",
     "proxy",
@@ -20,7 +20,7 @@
     },
     {
       "name": "cmake-modules",
-      "version": "1.3.0"
+      "version": "1.3.6"
     },
     {
       "name": "robotology-cmake-ycm",
@@ -31,7 +31,7 @@
     "registries": [
       {
         "kind": "git",
-        "baseline": "b58077c46126bee7c5cd54c26a4b974055c21d2b",
+        "baseline": "8166fd34bde37098afa04b82b0ec7f2a2f467fe3",
         "repository": "https://github.com/msclock/cmake-registry",
         "packages": [
           "cmake-modules",