CMake: reworked whole archive linking commands

Author: TheMostDiligent

BuildTools/CMake/BuildUtils.cmake

@@ -499,3 +499,35 @@ function(set_targets_emscripten_properties)
         endforeach()
     endif()
 endfunction()
+
+
+# Links the static library <lib> to the target <tgt> as a whole archive.
+function(target_link_whole_archive tgt lib)
+    if(MSVC)
+        target_link_libraries(${tgt} PRIVATE ${lib})
+    else()
+        if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.24)
+            # Use the new $<LINK_LIBRARY:WHOLE_ARCHIVE,lib> generator expression.
+            # This one argument expands to the right flags automatically on
+            # every toolchain (-Wl,--whole-archive/--no-whole-archive on ELF,
+            # -Wl,-force_load on Apple, /WHOLEARCHIVE on MSVC, ...).
+            target_link_libraries(
+                ${tgt} PRIVATE
+                "$<LINK_LIBRARY:WHOLE_ARCHIVE,${lib}>"
+            )
+        else()
+            # Legacy toolchains: add the flags by hand.
+            if(APPLE)
+                target_link_libraries(
+                    ${tgt} PRIVATE
+                    "-Wl,-force_load,$<TARGET_FILE:${lib}>"
+                )
+            else()
+                target_link_libraries(
+                    ${tgt} PRIVATE
+                    "-Wl,--whole-archive" ${lib} "-Wl,--no-whole-archive"
+                )
+            endif()
+        endif()
+    endif()
+endfunction()

CMakeLists.txt

@@ -445,22 +445,6 @@ else()
 endif(MSVC)
 
 
-if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR
-    CMAKE_CXX_COMPILER_ID MATCHES "GNU")
-    if(PLATFORM_APPLE)
-        # Looks like force_load is preferable over all_load
-        set(WHOLE_ARCHIVE_FLAG "-Wl,-force_load" CACHE INTERNAL "all_load flag")
-        # Option -noall_load is obsolete and there is no -noforce_load
-        set(NO_WHOLE_ARCHIVE_FLAG "" CACHE INTERNAL "noall_load flag")
-    else()
-        set(WHOLE_ARCHIVE_FLAG "-Wl,--whole-archive" CACHE INTERNAL "whole-archive flag")
-        set(NO_WHOLE_ARCHIVE_FLAG "-Wl,--no-whole-archive" CACHE INTERNAL "no-whole-archive flag")
-    endif()
-else()
-    set(WHOLE_ARCHIVE_FLAG "")
-    set(NO_WHOLE_ARCHIVE_FLAG "")
-endif()
-
 if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
     # Treat warnings as errors
     set(DILIGENT_CLANG_COMPILE_OPTIONS "" CACHE STRING "Common Clang compile options")

Graphics/Archiver/CMakeLists.txt

@@ -1,5 +1,7 @@
 cmake_minimum_required (VERSION 3.10)
 
+include(../../BuildTools/CMake/BuildUtils.cmake)
+
 project(Diligent-Archiver CXX)
 
 set(INCLUDE
@@ -181,8 +183,8 @@ PUBLIC
     Diligent-ArchiverInterface
 PRIVATE
     Diligent-BuildSettings
-    ${WHOLE_ARCHIVE_FLAG} Diligent-Archiver-static ${NO_WHOLE_ARCHIVE_FLAG}
 )
+target_link_whole_archive(Diligent-Archiver-shared Diligent-Archiver-static)
 
 if(PLATFORM_WIN32)
     # Do not add 'lib' prefix when building with MinGW

Graphics/GraphicsEngineOpenGL/CMakeLists.txt

@@ -1,5 +1,7 @@
 cmake_minimum_required (VERSION 3.10)
 
+include(../../BuildTools/CMake/BuildUtils.cmake)
+
 project(Diligent-GraphicsEngineOpenGL CXX)
 
 set(INCLUDE
@@ -262,10 +264,10 @@ PUBLIC
 target_link_libraries(Diligent-GraphicsEngineOpenGL-shared
 PRIVATE
     Diligent-BuildSettings
-    ${WHOLE_ARCHIVE_FLAG} Diligent-GraphicsEngineOpenGL-static ${NO_WHOLE_ARCHIVE_FLAG}
 PUBLIC
     ${PUBLIC_DEPENDENCIES}
 )
+target_link_whole_archive(Diligent-GraphicsEngineOpenGL-shared Diligent-GraphicsEngineOpenGL-static)
 
 target_compile_definitions(Diligent-GraphicsEngineOpenGL-shared PUBLIC ENGINE_DLL=1)
 if(PLATFORM_MACOS)

Graphics/GraphicsEngineVulkan/CMakeLists.txt

@@ -1,5 +1,6 @@
 cmake_minimum_required (VERSION 3.10)
 
+include(../../BuildTools/CMake/BuildUtils.cmake)
 include(../../BuildTools/CMake/VulkanUtils.cmake)
 
 project(Diligent-GraphicsEngineVk CXX)
@@ -286,10 +287,11 @@ PUBLIC
 target_link_libraries(Diligent-GraphicsEngineVk-shared
 PRIVATE
     Diligent-BuildSettings
-    ${WHOLE_ARCHIVE_FLAG} Diligent-GraphicsEngineVk-static ${NO_WHOLE_ARCHIVE_FLAG}
 PUBLIC
     ${PUBLIC_DEPENDENCIES}
 )
+target_link_whole_archive(Diligent-GraphicsEngineVk-shared Diligent-GraphicsEngineVk-static)
+
 
 if (MINGW_BUILD)
     # Restrict export to GetEngineFactoryVk

Tests/GPUTestFramework/CMakeLists.txt

@@ -1,5 +1,7 @@
 cmake_minimum_required (VERSION 3.17)
 
+include(../../BuildTools/CMake/BuildUtils.cmake)
+
 project(Diligent-GPUTestFramework)
 
 set(SOURCE src/GPUTestingEnvironment.cpp src/TestingSwapChainBase.cpp)
@@ -156,5 +158,6 @@ set_target_properties(Diligent-GPUTestFramework PROPERTIES
 )
 
 if (TARGET Diligent-Archiver-shared)
-    target_link_libraries(Diligent-GPUTestFramework PUBLIC Diligent-Archiver-shared)
+    get_backend_libraries_type(LIB_TYPE)
+    target_link_libraries(Diligent-GPUTestFramework PUBLIC Diligent-Archiver-${LIB_TYPE})
 endif()