[CMake] Modify swift_install_in_component to support cmake install co…

…mponents CMake supports the notion of installation components. Right now we have some custom code for supporting swift components. I think that for installation purposes, it would be nice to use the CMake component system. This should be a non-functional change. We should still only be generating install rules for targets and files in components we want to install, and we still use the install ninja target to install everything.
athas · Apr 19, 2019 · 3d9a289 · 3d9a289
1 parent 84d96ad
commit 3d9a289
Show file tree

Hide file tree

Showing 25 changed files with 190 additions and 193 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -998,17 +998,17 @@ if(SWIFT_NEED_EXPLICIT_LIBDISPATCH)
   else()
     set(SOURCEKIT_RUNTIME_DIR lib)
   endif()
-  swift_install_in_component(sourcekit-inproc
-                             FILES
+  swift_install_in_component(FILES
                                $<TARGET_FILE:dispatch>
                                $<TARGET_FILE:BlocksRuntime>
-                             DESTINATION ${SOURCEKIT_RUNTIME_DIR})
+                             DESTINATION ${SOURCEKIT_RUNTIME_DIR}
+                             COMPONENT sourcekit-inproc)
   if(SWIFT_HOST_VARIANT_SDK STREQUAL WINDOWS)
-    swift_install_in_component(sourcekit-inproc
-                               FILES
+    swift_install_in_component(FILES
                                  $<TARGET_LINKER_FILE:dispatch>
                                  $<TARGET_LINKER_FILE:BlocksRuntime>
-                               DESTINATION lib)
+                               DESTINATION lib
+                               COMPONENT sourcekit-inproc)
   endif()
 
 
@@ -1083,9 +1083,9 @@ endif()
 
 add_subdirectory(cmake/modules)
 
-swift_install_in_component(license
-  FILES "LICENSE.txt"
-  DESTINATION "share/swift")
+swift_install_in_component(FILES "LICENSE.txt"
+                           DESTINATION "share/swift"
+                           COMPONENT license)
 
 # Add a documentation target so that documentation shows up in the
 # Xcode project.

diff --git a/apinotes/CMakeLists.txt b/apinotes/CMakeLists.txt
@@ -31,7 +31,7 @@ add_custom_target("copy_apinotes"
 # This is treated as an OPTIONAL target because if we don't build the SDK
 # overlay, the files will be missing anyway. It also allows us to build
 # single overlays without installing the API notes.
-swift_install_in_component(sdk-overlay
-    DIRECTORY "${output_dir}"
-    DESTINATION "lib/swift/"
-    OPTIONAL)
+swift_install_in_component(DIRECTORY "${output_dir}"
+                           DESTINATION "lib/swift/"
+                           COMPONENT sdk-overlay
+                           OPTIONAL)
diff --git a/cmake/modules/AddSwift.cmake b/cmake/modules/AddSwift.cmake
@@ -1452,11 +1452,11 @@ function(add_swift_host_library name)
     )
 
   if(NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
-    swift_install_in_component(dev
-      TARGETS ${name}
-      ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX}
-      LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX}
-      RUNTIME DESTINATION bin)
+    swift_install_in_component(TARGETS ${name}
+                               ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX}
+                               LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX}
+                               RUNTIME DESTINATION bin
+                               COMPONENT dev)
   endif()
 
   swift_is_installing_component(dev is_installing)
@@ -2018,27 +2018,27 @@ function(add_swift_target_library name)
       endif()
 
       if(sdk STREQUAL WINDOWS AND CMAKE_SYSTEM_NAME STREQUAL Windows)
-        swift_install_in_component("${SWIFTLIB_INSTALL_IN_COMPONENT}"
-          TARGETS ${name}-windows-${SWIFT_PRIMARY_VARIANT_ARCH}
-          RUNTIME DESTINATION "bin"
-          LIBRARY DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}/${SWIFT_PRIMARY_VARIANT_ARCH}"
-          ARCHIVE DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}/${SWIFT_PRIMARY_VARIANT_ARCH}"
-          PERMISSIONS ${file_permissions})
+        swift_install_in_component(TARGETS ${name}-windows-${SWIFT_PRIMARY_VARIANT_ARCH}
+                                   RUNTIME DESTINATION "bin"
+                                   LIBRARY DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}/${SWIFT_PRIMARY_VARIANT_ARCH}"
+                                   ARCHIVE DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}/${SWIFT_PRIMARY_VARIANT_ARCH}"
+                                   COMPONENT "${SWIFTLIB_INSTALL_IN_COMPONENT}"
+                                   PERMISSIONS ${file_permissions})
       else()
-        swift_install_in_component("${SWIFTLIB_INSTALL_IN_COMPONENT}"
-            FILES "${UNIVERSAL_LIBRARY_NAME}"
-            DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}"
-            PERMISSIONS ${file_permissions}
-            "${optional_arg}")
+        swift_install_in_component(FILES "${UNIVERSAL_LIBRARY_NAME}"
+                                   DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}"
+                                   COMPONENT "${SWIFTLIB_INSTALL_IN_COMPONENT}"
+                                   PERMISSIONS ${file_permissions}
+                                   "${optional_arg}")
       endif()
       if(sdk STREQUAL WINDOWS)
         foreach(arch ${SWIFT_SDK_WINDOWS_ARCHITECTURES})
           if(TARGET ${name}-windows-${arch}_IMPLIB)
             get_target_property(import_library ${name}-windows-${arch}_IMPLIB IMPORTED_LOCATION)
-            swift_install_in_component(${SWIFTLIB_INSTALL_IN_COMPONENT}
-              FILES ${import_library}
-              DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}/${arch}"
-              PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
+            swift_install_in_component(FILES ${import_library}
+                                       DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/${resource_dir}/${resource_dir_sdk_subdir}/${arch}"
+                                       COMPONENT ${SWIFTLIB_INSTALL_IN_COMPONENT}
+                                       PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
           endif()
         endforeach()
       endif()
@@ -2070,14 +2070,14 @@ function(add_swift_target_library name)
                                OUTPUT
                                  "${UNIVERSAL_LIBRARY_NAME}"
                                ${THIN_INPUT_TARGETS_STATIC})
-        swift_install_in_component("${SWIFTLIB_INSTALL_IN_COMPONENT}"
-            FILES "${UNIVERSAL_LIBRARY_NAME}"
-            DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/swift_static/${resource_dir_sdk_subdir}"
-            PERMISSIONS
-              OWNER_READ OWNER_WRITE
-              GROUP_READ
-              WORLD_READ
-            "${optional_arg}")
+        swift_install_in_component(FILES "${UNIVERSAL_LIBRARY_NAME}"
+                                   DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/swift_static/${resource_dir_sdk_subdir}"
+                                   PERMISSIONS
+                                     OWNER_READ OWNER_WRITE
+                                     GROUP_READ
+                                     WORLD_READ
+                                   COMPONENT "${SWIFTLIB_INSTALL_IN_COMPONENT}"
+                                   "${optional_arg}")
       endif()
 
       # Add Swift standard library targets as dependencies to the top-level
@@ -2260,9 +2260,9 @@ function(add_swift_host_tool executable)
     ARCHITECTURE ${SWIFT_HOST_VARIANT_ARCH}
     ${ASHT_UNPARSED_ARGUMENTS})
 
-  swift_install_in_component(${ASHT_SWIFT_COMPONENT}
-    TARGETS ${executable}
-    RUNTIME DESTINATION bin)
+  swift_install_in_component(TARGETS ${executable}
+                             RUNTIME DESTINATION bin
+                             COMPONENT ${ASHT_SWIFT_COMPONENT})
 
   swift_is_installing_component(${ASHT_SWIFT_COMPONENT} is_installing)
 

diff --git a/cmake/modules/SwiftComponents.cmake b/cmake/modules/SwiftComponents.cmake
@@ -127,42 +127,30 @@ function(swift_is_installing_component component result_var_name)
   endif()
 endfunction()
 
-# swift_install_in_component(<COMPONENT NAME>
-#   <same parameters as install()>)
+# swift_install_in_component(<same parameters as install()>)
 #
 # Executes the specified installation actions if the named component is
 # requested to be installed.
 #
 # This function accepts the same parameters as install().
-function(swift_install_in_component component)
-  precondition(component MESSAGE "Component name is required")
+function(swift_install_in_component)
+  cmake_parse_arguments(
+      ARG # prefix
+      "" # options
+      "COMPONENT" # single-value args
+      "" # multi-value args
+      ${ARGN})
 
-  swift_is_installing_component("${component}" is_installing)
+  precondition(ARG_COMPONENT MESSAGE "Component name is required")
+
+  swift_is_installing_component("${ARG_COMPONENT}" is_installing)
   if(NOT is_installing)
     return()
   endif()
 
   install(${ARGN})
 endfunction()
 
-# swift_install_in_either_component(<COMPONENT1 NAME> <COMPONENT2 NAME>
-#   <same parameters as install()>)
-#
-# Executes the specified installation actions if either one of the named
-# components is requested to be installed.
-#
-# This function accepts the same parameters as install().
-function(swift_install_in_either_component comp1 comp2)
-  foreach(component ${comp1} ${comp2})
-    precondition(component MESSAGE "Component name is required")
-    swift_is_installing_component("${component}" is_installing)
-    if(is_installing)
-      install(${ARGN})
-      return()
-    endif()
-  endforeach(component)
-endfunction()
-
 function(swift_install_symlink_component component)
   cmake_parse_arguments(
       ARG # prefix

diff --git a/cmake/modules/SwiftManpage.cmake b/cmake/modules/SwiftManpage.cmake
@@ -38,8 +38,8 @@ function(manpage)
       DEPENDS "${MP_SOURCE}"
       ALL)
 
-  swift_install_in_component("${MP_INSTALL_IN_COMPONENT}"
-      FILES "${output_file_name}"
-      DESTINATION "share/man/man${MP_MAN_SECTION}")
+  swift_install_in_component(FILES "${output_file_name}"
+                             DESTINATION "share/man/man${MP_MAN_SECTION}"
+                             COMPONENT "${MP_INSTALL_IN_COMPONENT}")
 endfunction()
 
diff --git a/cmake/modules/SwiftSource.cmake b/cmake/modules/SwiftSource.cmake
@@ -340,14 +340,14 @@ function(_compile_swift_files
   endif()
 
   if(SWIFTFILE_SDK IN_LIST SWIFT_APPLE_PLATFORMS)
-    swift_install_in_component("${SWIFTFILE_INSTALL_IN_COMPONENT}"
-      DIRECTORY "${specific_module_dir}"
-      DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/swift/${library_subdir}"
-      OPTIONAL)
+    swift_install_in_component(DIRECTORY "${specific_module_dir}"
+                               DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/swift/${library_subdir}"
+                               COMPONENT "${SWIFTFILE_INSTALL_IN_COMPONENT}"
+                               OPTIONAL)
   else()
-    swift_install_in_component("${SWIFTFILE_INSTALL_IN_COMPONENT}"
-      FILES ${module_outputs}
-      DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/swift/${library_subdir}")
+    swift_install_in_component(FILES ${module_outputs}
+                               DESTINATION "lib${LLVM_LIBDIR_SUFFIX}/swift/${library_subdir}"
+                               COMPONENT "${SWIFTFILE_INSTALL_IN_COMPONENT}")
   endif()
 
   set(line_directive_tool "${SWIFT_SOURCE_DIR}/utils/line-directive")

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -68,8 +68,8 @@ if (DOXYGEN_FOUND)
     add_dependencies(doxygen doxygen-swift)
   endif()
 
-  swift_install_in_component(dev
-      DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doxygen/html"
-      DESTINATION "docs/html")
+  swift_install_in_component(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doxygen/html"
+                             DESTINATION "docs/html"
+                             COMPONENT dev)
 endif()
 endif()
diff --git a/include/swift/SwiftRemoteMirror/CMakeLists.txt b/include/swift/SwiftRemoteMirror/CMakeLists.txt
@@ -4,9 +4,10 @@ list(APPEND swift_remote_mirror_headers
        Platform.h
        SwiftRemoteMirror.h
        SwiftRemoteMirrorTypes.h)
-swift_install_in_component("swift-remote-mirror-headers"
-                           FILES
+swift_install_in_component(FILES
                              ${swift_remote_mirror_headers}
                            DESTINATION
-                             "include/swift/SwiftRemoteMirror")
+                             "include/swift/SwiftRemoteMirror"
+                           COMPONENT
+                             swift-remote-mirror-headers)
 
diff --git a/lib/Driver/CMakeLists.txt b/lib/Driver/CMakeLists.txt
@@ -56,9 +56,9 @@ if(SWIFT_BUILD_STATIC_STDLIB)
           "${SWIFT_SOURCE_DIR}/utils/gen-static-stdlib-link-args")
 
       list(APPEND static_stdlib_lnk_file_list ${swift_static_stdlib_${sdk}_args})
-      swift_install_in_component(stdlib
-        FILES "${SWIFTSTATICLIB_DIR}/${linkfile}"
-        DESTINATION "lib/swift_static/${lowercase_sdk}")
+      swift_install_in_component(FILES "${SWIFTSTATICLIB_DIR}/${linkfile}"
+                                 DESTINATION "lib/swift_static/${lowercase_sdk}"
+                                 COMPONENT stdlib)
     endif()
   endforeach()
   add_custom_target(swift_static_lnk_args ALL DEPENDS ${static_stdlib_lnk_file_list})

diff --git a/lib/Migrator/CMakeLists.txt b/lib/Migrator/CMakeLists.txt
@@ -43,9 +43,9 @@ add_custom_target("symlink_migrator_data"
     DEPENDS "${output_dir}" "${outputs}"
     COMMENT "Symlinking migrator data to ${output_dir}")
 
-swift_install_in_component(compiler
-  FILES ${datafiles}
-DESTINATION "lib/swift/migrator")
+swift_install_in_component(FILES ${datafiles}
+                           DESTINATION "lib/swift/migrator"
+                           COMPONENT compiler)
 
 add_swift_host_library(swiftMigrator STATIC
   APIDiffMigratorPass.cpp

diff --git a/lib/SwiftDemangle/CMakeLists.txt b/lib/SwiftDemangle/CMakeLists.txt
@@ -6,7 +6,7 @@ target_compile_definitions(swiftDemangle PRIVATE
 target_link_libraries(swiftDemangle PRIVATE
   swiftDemangling)
 
-swift_install_in_component(compiler
-    TARGETS swiftDemangle
-    LIBRARY DESTINATION "lib${LLVM_LIBDIR_SUFFIX}"
-    ARCHIVE DESTINATION "lib${LLVM_LIBDIR_SUFFIX}")
+swift_install_in_component(TARGETS swiftDemangle
+                           LIBRARY DESTINATION "lib${LLVM_LIBDIR_SUFFIX}"
+                           ARCHIVE DESTINATION "lib${LLVM_LIBDIR_SUFFIX}"
+                           COMPONENT compiler)
diff --git a/stdlib/CMakeLists.txt b/stdlib/CMakeLists.txt
@@ -143,9 +143,9 @@ foreach(sdk ${SWIFT_SDKS})
         "swift-stdlib-${platform}-${arch}"
         "copy-legacy-layouts-${platform}-${arch}")
 
-      swift_install_in_component(compiler
-          FILES ${input}
-          DESTINATION "lib/swift/${platform}/")
+      swift_install_in_component(FILES ${input}
+                                 DESTINATION "lib/swift/${platform}/"
+                                 COMPONENT compiler)
     else()
       # Add a dummy target that does nothing so we can still depend on it
       # later without checking if the input files exist.

diff --git a/stdlib/public/Platform/CMakeLists.txt b/stdlib/public/Platform/CMakeLists.txt
@@ -129,9 +129,9 @@ foreach(sdk ${SWIFT_SDKS})
     #        It is not relocatable to the target platform itself.
     #        This affects any cross-comipled targets that use glibc.modulemap.
 
-    swift_install_in_component(sdk-overlay
-        FILES "${glibc_modulemap_out}"
-        DESTINATION "lib/swift/${arch_subdir}")
+    swift_install_in_component(FILES "${glibc_modulemap_out}"
+                               DESTINATION "lib/swift/${arch_subdir}"
+                               COMPONENT sdk-overlay)
 
   endforeach()
 endforeach()

diff --git a/stdlib/public/SwiftShims/CMakeLists.txt b/stdlib/public/SwiftShims/CMakeLists.txt
@@ -105,16 +105,16 @@ add_custom_command_target(unused_var
     COMMENT "Symlinking Clang resource headers into ${SWIFTLIB_DIR}/clang")
 add_dependencies(copy_shim_headers symlink_clang_headers)
 
-swift_install_in_component(stdlib
-    FILES ${sources}
-    DESTINATION "lib/swift/shims")
+swift_install_in_component(FILES ${sources}
+                           DESTINATION "lib/swift/shims"
+                           COMPONENT stdlib)
 
 # Install Clang headers under the Swift library so that an installed Swift's
 # module importer can find the compiler headers corresponding to its Clang.
-swift_install_in_component(clang-builtin-headers
-    DIRECTORY "${clang_headers_location}/"
-    DESTINATION "lib/swift/clang"
-    PATTERN "*.h")
+swift_install_in_component(DIRECTORY "${clang_headers_location}/"
+                           DESTINATION "lib/swift/clang"
+                           COMPONENT clang-builtin-headers
+                           PATTERN "*.h")
 
 swift_install_symlink_component(clang-resource-dir-symlink
   LINK_NAME clang
@@ -126,7 +126,7 @@ swift_install_symlink_component(clang-resource-dir-symlink
 # should be used in conjunction with clang-resource-dir-symlink.
 file(TO_CMAKE_PATH "${LLVM_LIBRARY_OUTPUT_INTDIR}"
   _SWIFT_SHIMS_PATH_TO_CLANG_BUILD)
-swift_install_in_component(clang-builtin-headers-in-clang-resource-dir
-    DIRECTORY "${_SWIFT_SHIMS_PATH_TO_CLANG_BUILD}/lib/clang"
-    DESTINATION "lib"
-    PATTERN "*.h")
+swift_install_in_component(DIRECTORY "${_SWIFT_SHIMS_PATH_TO_CLANG_BUILD}/lib/clang"
+                           DESTINATION "lib"
+                           COMPONENT clang-builtin-headers-in-clang-resource-dir
+                           PATTERN "*.h")