CMake: define installation components

'install' commands can receive 'COMPONENT' arguments (one per target file
kind). Upon request, CMake can install only the files associated to a given
component. This will be used to generate separate archives/pacakges/installers
with CPack.

The following components are declared:
- runtime (libparameter and libremote-processor);
- dev (everything necessary to develop a plugin or a client: headers, cmake
       package files, ...);
- c (the C bindings, i.e. libcparameter);
- cdev (everything necessary to develop a client using the C bindings);
- python (the Python bindings);
- eng (the various tools, XML schemas, ...);
- runtime-deps (on windows only: the msvc redistributable files).

Unfortunately, per-component debian package generation and automatic dependency
discovery (using shlibdeps) do not work together before CMake 3.4. Also,
per-component debian package dependency declaration has been added in CMake
3.4, so it is not possible yet to declare, for instance, that the 'dev' package
depends on the 'runtime' package.

However, the following works and generates one archive for each component:

    cpack -G TGZ -D CPACK_ARCHIVE_COMPONENT_INSTALL=ON

Signed-off-by: David Wagner <[email protected]>

Author: dawagner

.travis.yml

@@ -118,6 +118,10 @@ script:
         cmake $MY_CMAKE_OPTIONS . &&
         make &&
         make install ); fi
+  # Check that all installed files are in a component (no "unspecified
+  # component" archive created)
+  - (cd build && cpack -G TGZ -D CPACK_ARCHIVE_COMPONENT_INSTALL=ON &&
+     [ ! -x '*-Unspecified.tar.gz' ])
   # Keep this last
   - ( mkdir build_less_features && cd build_less_features &&
         rm -rf $PREFIX/asio-1.10.6 &&

bindings/c/CMakeLists.txt

@@ -33,11 +33,15 @@ generate_export_header(cparameter)
 
 install(FILES ParameterFramework.h
               "${CMAKE_CURRENT_BINARY_DIR}/cparameter_export.h"
-        DESTINATION "include/parameter/c")
+        DESTINATION "include/parameter/c"
+        COMPONENT c_dev)
 
 target_link_libraries(cparameter PRIVATE parameter pfw_utility)
 
-install(TARGETS cparameter LIBRARY DESTINATION lib RUNTIME DESTINATION bin ARCHIVE DESTINATION lib)
+install(TARGETS cparameter
+    LIBRARY DESTINATION lib COMPONENT c
+    RUNTIME DESTINATION bin COMPONENT c
+    ARCHIVE DESTINATION lib COMPONENT c_dev)
 
 if(BUILD_TESTING)
     # Add unit test

bindings/python/CMakeLists.txt

@@ -89,7 +89,8 @@ execute_process(COMMAND
          print(sysconfig.get_python_lib(plat_specific=True, prefix=''))"
     OUTPUT_VARIABLE PYTHON_MODULE_PATH OUTPUT_STRIP_TRAILING_WHITESPACE)
 
-install(TARGETS _PyPfw LIBRARY DESTINATION ${PYTHON_MODULE_PATH})
+install(TARGETS _PyPfw LIBRARY DESTINATION ${PYTHON_MODULE_PATH} COMPONENT python)
 
 # install the generated Python file as well
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/PyPfw.py DESTINATION ${PYTHON_MODULE_PATH})
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/PyPfw.py DESTINATION ${PYTHON_MODULE_PATH}
+    COMPONENT python)

cmake/CMakeLists.txt

@@ -43,8 +43,10 @@ export(EXPORT ParameterTargets
 
 install(EXPORT ParameterTargets DESTINATION lib/cmake/ParameterFramework
     FILE ParameterFrameworkTargets.cmake
-    NAMESPACE ParameterFramework::)
+    NAMESPACE ParameterFramework::
+    COMPONENT dev)
 install(FILES
     "${CMAKE_CURRENT_BINARY_DIR}/ParameterFrameworkConfig.cmake"
     "${CMAKE_CURRENT_BINARY_DIR}/ParameterFrameworkConfigVersion.cmake"
-    DESTINATION lib/cmake/ParameterFramework)
+    DESTINATION lib/cmake/ParameterFramework
+    COMPONENT dev)

cpack/CMakeLists.txt

@@ -47,6 +47,8 @@ set(CPACK_WIX_UPGRADE_GUID "47E60D10-B344-445D-A2F6-5684CC8B1D47")
 
 if (WIN32)
     # On windows, pack compiler provided libraries (MSVC redistributable) with the project
+    # Have cpack make a specific archive for them
+    set(CMAKE_INSTALL_SYSTEM_RUNTIME_COMPONENT runtime_deps)
     include(InstallRequiredSystemLibraries)
     # TODO: pack libxml2.dll with the project
 endif()

parameter/CMakeLists.txt

@@ -137,7 +137,9 @@ target_include_directories(parameter
     INTERFACE $<INSTALL_INTERFACE:include/parameter/plugin>)
 
 install(TARGETS parameter EXPORT ParameterTargets
-    LIBRARY DESTINATION lib RUNTIME DESTINATION bin ARCHIVE DESTINATION lib)
+    LIBRARY DESTINATION lib COMPONENT runtime
+    RUNTIME DESTINATION bin COMPONENT runtime
+    ARCHIVE DESTINATION lib COMPONENT dev)
 
 # Export an interface library for plugins to use (after the ParameterFramework
 # project is built and installed). It makes them link against libparameter and
@@ -147,7 +149,7 @@ target_link_libraries(plugin INTERFACE parameter)
 target_include_directories(plugin
     INTERFACE $<INSTALL_INTERFACE:include/parameter/xmlserializer>
     INTERFACE $<INSTALL_INTERFACE:include/parameter/utility>)
-install(TARGETS plugin EXPORT ParameterTargets)
+install(TARGETS plugin EXPORT ParameterTargets COMPONENT dev)
 # Unfortunately, while the "plugin" interface library is suitable for external
 # plugins (built using the installed Parameter Framework) we want to build some
 # plugins before the whole project is installed. Therefore, they need to get
@@ -167,7 +169,8 @@ install(FILES
     include/ParameterMgrPlatformConnector.h
     include/SelectionCriterionInterface.h
     include/SelectionCriterionTypeInterface.h
-    DESTINATION "include/parameter/client")
+    DESTINATION "include/parameter/client"
+    COMPONENT dev)
 # Core (plugin) headers
 install(FILES
     "${CMAKE_CURRENT_BINARY_DIR}/parameter_export.h"
@@ -194,6 +197,8 @@ install(FILES
     Syncer.h
     TypeElement.h
     VirtualSubsystem.h
-    DESTINATION "include/parameter/plugin")
+    DESTINATION "include/parameter/plugin"
+    COMPONENT dev)
 install(DIRECTORY log/include/log/
-        DESTINATION "include/parameter/plugin/log")
+        DESTINATION "include/parameter/plugin/log"
+        COMPONENT dev)

remote-process/CMakeLists.txt

@@ -35,5 +35,6 @@ if(NETWORKING)
     target_link_libraries(remote-process
                           PRIVATE remote-processor pfw_utility asio ${CMAKE_THREAD_LIBS_INIT})
 
-    install(TARGETS remote-process RUNTIME DESTINATION bin)
+    install(TARGETS remote-process RUNTIME DESTINATION bin
+            COMPONENT eng)
 endif()

remote-processor/CMakeLists.txt

@@ -43,4 +43,6 @@ find_package(Threads REQUIRED)
 target_link_libraries(remote-processor PRIVATE pfw_utility asio ${CMAKE_THREAD_LIBS_INIT})
 
 install(TARGETS remote-processor EXPORT ParameterTargets
-    LIBRARY DESTINATION lib RUNTIME DESTINATION bin)
+    LIBRARY DESTINATION lib COMPONENT runtime
+    RUNTIME DESTINATION bin COMPONENT runtime
+    ARCHIVE DESTINATION lib COMPONENT dev)

schemas/CMakeLists.txt

@@ -37,4 +37,5 @@ install(FILES ComponentLibrary.xsd
               Subsystem.xsd
               SystemClass.xsd
               W3cXmlAttributes.xsd
-        DESTINATION share/${PROJECT_NAME}/schemas)
+        DESTINATION share/${PROJECT_NAME}/schemas
+        COMPONENT eng)

test/test-platform/CMakeLists.txt

@@ -36,5 +36,5 @@ if(NETWORKING)
     # Workaround because asio is still leaking to test-platform
     target_link_libraries(test-platform PRIVATE asio)
 
-    install(TARGETS test-platform RUNTIME DESTINATION bin)
+    install(TARGETS test-platform RUNTIME DESTINATION bin COMPONENT eng)
 endif()