[cmake] add installWithRPATH

this new CMake function installs a target to a destination and adds the correct relative RPATH to some desired locations
2026-04-14 00:14:11 +09:00 · 2025-07-17 13:24:53 +02:00
parent 1d098015ae
commit 12d0e491f6
22 changed files with 220 additions and 34 deletions
--- a/channels/CMakeLists.txt
+++ b/channels/CMakeLists.txt
@@ -150,7 +150,7 @@ macro(channel_install _targets _destination _export_target)
    foreach(_target_name IN ITEMS ${_targets})
      target_include_directories(${_target_name} INTERFACE $<INSTALL_INTERFACE:include>)
    endforeach()
-    install(TARGETS ${_targets} DESTINATION ${_destination} EXPORT ${_export_target})
+    installwithrpath(TARGETS ${_targets} DESTINATION ${_destination} EXPORT ${_export_target})
  endif()
 endmacro(channel_install)

--- a/client/SDL/SDL3/CMakeLists.txt
+++ b/client/SDL/SDL3/CMakeLists.txt
@@ -84,7 +84,7 @@ string(TIMESTAMP SDL_CLIENT_YEAR "%Y")
 set(SDL_CLIENT_UUID "com.freerdp.client.sdl3")
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/sdl_config.hpp.in ${CMAKE_CURRENT_BINARY_DIR}/sdl_config.hpp @ONLY)

-install(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT client)
+installwithrpath(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT client)
 install_freerdp_desktop("${MODULE_NAME}" "${SDL_CLIENT_UUID}")

 add_subdirectory(man)
--- a/client/Sample/CMakeLists.txt
+++ b/client/Sample/CMakeLists.txt
@@ -41,5 +41,5 @@ set(LIBS freerdp-client freerdp winpr)
 target_link_libraries(${PROJECT_NAME} PRIVATE ${LIBS})

 set_property(TARGET ${PROJECT_NAME} PROPERTY FOLDER "Client/Sample")
-install(TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT client)
+installwithrpath(TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT client)
 install_freerdp_desktop("${PROJECT_NAME}")
--- a/client/X11/CMakeLists.txt
+++ b/client/X11/CMakeLists.txt
@@ -188,7 +188,7 @@ target_link_libraries(${PROJECT_NAME} PUBLIC ${PUB_LIBS})
 target_link_libraries(${PROJECT_NAME} PRIVATE ${PRIV_LIBS})

 if(WITH_CLIENT_INTERFACE)
-  install(TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT libraries)
+  installwithrpath(TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT libraries)
 endif()
 add_subdirectory(cli)
 add_subdirectory(man)
--- a/client/X11/cli/CMakeLists.txt
+++ b/client/X11/cli/CMakeLists.txt
@@ -25,7 +25,15 @@ list(APPEND LIBS xfreerdp-client)

 target_link_libraries(${MODULE_NAME} PRIVATE ${LIBS})

-install(TARGETS ${MODULE_NAME} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT client)
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
+  COMPONENT
+  client
+)
 install_freerdp_desktop("${MODULE_NAME}")

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Client/X11")
--- a/client/common/CMakeLists.txt
+++ b/client/common/CMakeLists.txt
@@ -96,9 +96,22 @@ target_include_directories(${MODULE_NAME} INTERFACE $<INSTALL_INTERFACE:include>
 target_link_libraries(${MODULE_NAME} PRIVATE ${FREERDP_CHANNELS_CLIENT_LIBS})
 target_link_libraries(${MODULE_NAME} PUBLIC ${LIBS})

-install(TARGETS ${MODULE_NAME} COMPONENT libraries EXPORT FreeRDP-ClientTargets
-        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  libraries
+  EXPORT
+  FreeRDP-ClientTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Client/Common")
--- a/cmake/ConfigureRPATH.cmake
+++ b/cmake/ConfigureRPATH.cmake
@@ -25,3 +25,37 @@ endif(APPLE)

 set(CMAKE_INSTALL_RPATH ${CFG_INSTALL_RPATH} CACHE INTERNAL "ConfigureRPATH")
 message("Configured RPATH=${CMAKE_INSTALL_RPATH}")
+
+function(installWithRPATH)
+  if(NOT APPLE AND NOT FREEBSD AND NOT WIN32)
+    list(FIND ARGN "TARGETS" _index)
+    if(${_index} GREATER -1)
+      math(EXPR _index "${_index}+1")
+      list(GET ARGN ${_index} target)
+    else()
+      message(FATAL_ERROR "Missing TARGETS for install directive")
+    endif()
+    list(FIND ARGN "DESTINATION" _index)
+    if(${_index} GREATER -1)
+      math(EXPR _index "${_index}+1")
+      list(GET ARGN ${_index} path)
+    else()
+      message(FATAL_ERROR "Missing DESTINATION for install directive")
+    endif()
+
+    get_filename_component(ABS_PATH ${path} ABSOLUTE BASE_DIR ${CMAKE_INSTALL_PREFIX})
+    file(RELATIVE_PATH REL_PATH ${ABS_PATH} ${CMAKE_INSTALL_PREFIX})
+    if(WITH_ADD_PLUGIN_TO_RPATH)
+      set_target_properties(
+        ${target}
+        PROPERTIES
+          INSTALL_RPATH
+          "\$ORIGIN/${REL_PATH}${FREERDP_EXTENSION_REL_PATH}:\$ORIGIN/${REL_PATH}${FREERDP_PLUGIN_PATH}:\$ORIGIN/${REL_PATH}${CMAKE_INSTALL_LIBDIR}"
+      )
+    else()
+      set_target_properties(${target} PROPERTIES INSTALL_RPATH "\$ORIGIN/${REL_PATH}${CMAKE_INSTALL_LIBDIR}")
+    endif()
+  endif()
+
+  install(${ARGN})
+endfunction()
--- a/libfreerdp/CMakeLists.txt
+++ b/libfreerdp/CMakeLists.txt
@@ -227,8 +227,22 @@ endif()
 target_include_directories(${MODULE_NAME} INTERFACE $<INSTALL_INTERFACE:include>)
 target_link_libraries(${MODULE_NAME} PRIVATE ${LIBFREERDP_LIBS})
 target_link_libraries(${MODULE_NAME} PUBLIC ${LIBFREERDP_PUB_LIBS})
-install(TARGETS ${MODULE_NAME} COMPONENT libraries EXPORT FreeRDPTargets ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  libraries
+  EXPORT
+  FreeRDPTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "FreeRDP/libfreerdp")
--- a/rdtk/librdtk/CMakeLists.txt
+++ b/rdtk/librdtk/CMakeLists.txt
@@ -50,7 +50,21 @@ if(BUILD_TESTING_INTERNAL OR BUILD_TESTING)
 endif()

 if(NOT RDTK_FORCE_STATIC_BUILD)
-  install(TARGETS ${MODULE_NAME} COMPONENT libraries EXPORT rdtk ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-          LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  installwithrpath(
+    TARGETS
+    ${MODULE_NAME}
+    COMPONENT
+    libraries
+    EXPORT
+    rdtk
+    ARCHIVE
+    DESTINATION
+    ${CMAKE_INSTALL_LIBDIR}
+    LIBRARY
+    DESTINATION
+    ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME
+    DESTINATION
+    ${CMAKE_INSTALL_BINDIR}
  )
 endif()
--- a/server/Sample/CMakeLists.txt
+++ b/server/Sample/CMakeLists.txt
@@ -58,6 +58,6 @@ list(APPEND LIBS freerdp-server)
 list(APPEND LIBS winpr freerdp)

 target_link_libraries(${MODULE_NAME} ${LIBS})
-install(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT server)
+installwithrpath(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT server)

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Server/Sample")
--- a/server/common/CMakeLists.txt
+++ b/server/common/CMakeLists.txt
@@ -34,9 +34,22 @@ target_include_directories(${MODULE_NAME} INTERFACE $<INSTALL_INTERFACE:include>
 target_link_libraries(${MODULE_NAME} PRIVATE ${FREERDP_CHANNELS_SERVER_LIBS})
 target_link_libraries(${MODULE_NAME} PUBLIC winpr freerdp)

-install(TARGETS ${MODULE_NAME} COMPONENT libraries EXPORT FreeRDP-ServerTargets
-        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  libraries
+  EXPORT
+  FreeRDP-ServerTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Server/Common")
--- a/server/proxy/CMakeLists.txt
+++ b/server/proxy/CMakeLists.txt
@@ -56,8 +56,22 @@ set(PUBLIC_LIBS winpr freerdp)
 target_include_directories(${MODULE_NAME} INTERFACE $<INSTALL_INTERFACE:include>)
 target_link_libraries(${MODULE_NAME} PRIVATE ${PRIVATE_LIBS} PUBLIC ${PUBLIC_LIBS})

-install(TARGETS ${MODULE_NAME} COMPONENT server EXPORT FreeRDP-ProxyTargets ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  server
+  EXPORT
+  FreeRDP-ProxyTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Server/Proxy")
--- a/server/proxy/cli/CMakeLists.txt
+++ b/server/proxy/cli/CMakeLists.txt
@@ -22,7 +22,7 @@ set(APP_NAME "freerdp-proxy")
 addtargetwithresourcefile(${APP_NAME} TRUE "${FREERDP_VERSION}" PROXY_APP_SRCS)

 target_link_libraries(${APP_NAME} ${MODULE_NAME})
-install(TARGETS ${APP_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT server)
+installwithrpath(TARGETS ${APP_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT server)

 set_property(TARGET ${APP_NAME} PROPERTY FOLDER "Server/proxy")

--- a/server/proxy/modules/bitmap-filter/CMakeLists.txt
+++ b/server/proxy/modules/bitmap-filter/CMakeLists.txt
@@ -42,4 +42,4 @@ addtargetwithresourcefile(${PROJECT_NAME} FALSE "${PROJECT_VERSION}" SRCS FALSE)

 target_link_libraries(${PROJECT_NAME} winpr freerdp)

-install(TARGETS ${PROJECT_NAME} DESTINATION ${FREERDP_PROXY_PLUGINDIR})
+installwithrpath(TARGETS ${PROJECT_NAME} DESTINATION ${FREERDP_PROXY_PLUGINDIR})
--- a/server/proxy/modules/demo/CMakeLists.txt
+++ b/server/proxy/modules/demo/CMakeLists.txt
@@ -42,4 +42,4 @@ addtargetwithresourcefile(${PROJECT_NAME} FALSE "${PROJECT_VERSION}" SRCS FALSE)

 target_link_libraries(${PROJECT_NAME} winpr)

-install(TARGETS ${PROJECT_NAME} DESTINATION ${FREERDP_PROXY_PLUGINDIR})
+installwithrpath(TARGETS ${PROJECT_NAME} DESTINATION ${FREERDP_PROXY_PLUGINDIR})
--- a/server/proxy/modules/dyn-channel-dump/CMakeLists.txt
+++ b/server/proxy/modules/dyn-channel-dump/CMakeLists.txt
@@ -41,4 +41,4 @@ addtargetwithresourcefile(${PROJECT_NAME} FALSE "${PROJECT_VERSION}" SRCS FALSE)

 target_link_libraries(${PROJECT_NAME} PRIVATE winpr freerdp freerdp-client freerdp-server freerdp-server-proxy)

-install(TARGETS ${PROJECT_NAME} DESTINATION ${FREERDP_PROXY_PLUGINDIR})
+installwithrpath(TARGETS ${PROJECT_NAME} DESTINATION ${FREERDP_PROXY_PLUGINDIR})
--- a/server/shadow/CMakeLists.txt
+++ b/server/shadow/CMakeLists.txt
@@ -80,8 +80,22 @@ list(
 target_include_directories(${MODULE_NAME} INTERFACE $<INSTALL_INTERFACE:include>)
 target_link_libraries(${MODULE_NAME} PRIVATE ${LIBS})

-install(TARGETS ${MODULE_NAME} COMPONENT server EXPORT FreeRDP-ShadowTargets ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  server
+  EXPORT
+  FreeRDP-ShadowTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Server/shadow")
@@ -113,11 +127,27 @@ target_include_directories(${MODULE_NAME} INTERFACE $<INSTALL_INTERFACE:include>
 target_link_libraries(${MODULE_NAME} PRIVATE ${LIBS})

 if(NOT BUILD_SHARED_LIBS)
-  install(TARGETS freerdp-shadow-subsystem-impl DESTINATION ${CMAKE_INSTALL_LIBDIR} EXPORT FreeRDP-ShadowTargets)
+  installwithrpath(
+    TARGETS freerdp-shadow-subsystem-impl DESTINATION ${CMAKE_INSTALL_LIBDIR} EXPORT FreeRDP-ShadowTargets
+  )
 endif()

-install(TARGETS ${MODULE_NAME} COMPONENT server EXPORT FreeRDP-ShadowTargets ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  server
+  EXPORT
+  FreeRDP-ShadowTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Server/shadow")
--- a/server/shadow/cli/CMakeLists.txt
+++ b/server/shadow/cli/CMakeLists.txt
@@ -26,5 +26,5 @@ list(APPEND LIBS freerdp-shadow-subsystem freerdp-shadow freerdp winpr)

 target_link_libraries(${MODULE_NAME} PRIVATE ${LIBS})

-install(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT server)
+installwithrpath(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT server)
 generate_and_install_freerdp_man_from_template(${MODULE_NAME} "1" "${FREERDP_API_VERSION}")
--- a/winpr/libwinpr/CMakeLists.txt
+++ b/winpr/libwinpr/CMakeLists.txt
@@ -245,8 +245,22 @@ target_compile_options(${MODULE_NAME} PRIVATE ${WINPR_COMPILE_OPTIONS})
 target_compile_definitions(${MODULE_NAME} PRIVATE ${WINPR_DEFINITIONS})

 target_link_libraries(${MODULE_NAME} PRIVATE ${WINPR_LIBS_PRIVATE} PUBLIC ${WINPR_LIBS_PUBLIC})
-install(TARGETS ${MODULE_NAME} COMPONENT libraries EXPORT WinPRTargets ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  libraries
+  EXPORT
+  WinPRTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "WinPR/libwinpr")
--- a/winpr/tools/CMakeLists.txt
+++ b/winpr/tools/CMakeLists.txt
@@ -91,8 +91,22 @@ add_compile_definitions(${WINPR_DEFINITIONS})
 target_include_directories(${MODULE_NAME} INTERFACE $<INSTALL_INTERFACE:include/winpr${WINPR_VERSION_MAJOR}>)
 target_link_libraries(${MODULE_NAME} PRIVATE ${WINPR_TOOLS_LIBS})

-install(TARGETS ${MODULE_NAME} COMPONENT libraries EXPORT WinPR-toolsTargets ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  COMPONENT
+  libraries
+  EXPORT
+  WinPR-toolsTargets
+  ARCHIVE
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  LIBRARY
+  DESTINATION
+  ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
 )

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "WinPR/Tools")
--- a/winpr/tools/hash-cli/CMakeLists.txt
+++ b/winpr/tools/hash-cli/CMakeLists.txt
@@ -26,7 +26,16 @@ set(${MODULE_PREFIX}_LIBS winpr)

 target_link_libraries(${MODULE_NAME} ${${MODULE_PREFIX}_LIBS})

-install(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT tools EXPORT WinPRTargets)
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
+  COMPONENT
+  tools
+  EXPORT
+  WinPRTargets
+)

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "WinPR/Tools")
 generate_and_install_freerdp_man_from_template(${MODULE_NAME} "1" "${WINPR_API_VERSION}")
--- a/winpr/tools/makecert-cli/CMakeLists.txt
+++ b/winpr/tools/makecert-cli/CMakeLists.txt
@@ -29,6 +29,15 @@ target_link_libraries(${MODULE_NAME} ${${MODULE_PREFIX}_LIBS} winpr)

 set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "WinPR/Tools")

-install(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT tools EXPORT WinPRTargets)
+installwithrpath(
+  TARGETS
+  ${MODULE_NAME}
+  DESTINATION
+  ${CMAKE_INSTALL_BINDIR}
+  COMPONENT
+  tools
+  EXPORT
+  WinPRTargets
+)

 generate_and_install_freerdp_man_from_template(${MODULE_NAME} "1" "${WINPR_API_VERSION}")