[CMake] Move cross-platform dispatch/blocks support to the tools level, in preparation for the syntax parser library

Author: akyrtzi

CMakeLists.txt

@@ -399,23 +399,37 @@ endif()
 
 precondition(CMAKE_SYSTEM_NAME)
 if("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
+  set(SWIFT_BUILD_SYNTAXPARSERLIB_default TRUE)
   set(SWIFT_BUILD_SOURCEKIT_default TRUE)
 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
   if(EXISTS ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE})
+    set(SWIFT_BUILD_SYNTAXPARSERLIB_default TRUE)
     set(SWIFT_BUILD_SOURCEKIT_default TRUE)
   else()
+    set(SWIFT_BUILD_SYNTAXPARSERLIB_default FALSE)
     set(SWIFT_BUILD_SOURCEKIT_default FALSE)
   endif()
 else()
+    set(SWIFT_BUILD_SYNTAXPARSERLIB_default FALSE)
     set(SWIFT_BUILD_SOURCEKIT_default FALSE)
 endif()
+option(SWIFT_BUILD_SYNTAXPARSERLIB
+    "Build the Swift Syntax Parser library"
+    ${SWIFT_BUILD_SYNTAXPARSERLIB_default})
 option(SWIFT_BUILD_SOURCEKIT
     "Build SourceKit"
     ${SWIFT_BUILD_SOURCEKIT_default})
 option(SWIFT_ENABLE_SOURCEKIT_TESTS
     "Enable running SourceKit tests"
     ${SWIFT_BUILD_SOURCEKIT_default})
 
+if(NOT "${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin" AND
+  (SWIFT_BUILD_SYNTAXPARSERLIB OR SWIFT_BUILD_SOURCEKIT))
+  set(SWIFT_NEED_EXPLICIT_LIBDISPATCH TRUE)
+else()
+  set(SWIFT_NEED_EXPLICIT_LIBDISPATCH FALSE)
+endif()
+
 #
 # Assume a new enough ar to generate the index at construction time. This avoids
 # having to invoke ranlib as a secondary command.
@@ -880,6 +894,96 @@ if (LLVM_ENABLE_DOXYGEN)
   message(STATUS "Doxygen: enabled")
 endif()
 
+if(SWIFT_NEED_EXPLICIT_LIBDISPATCH)
+  if(CMAKE_C_COMPILER_ID STREQUAL Clang AND
+     CMAKE_C_COMPILER_VERSION VERSION_GREATER 3.8
+     OR LLVM_USE_SANITIZER)
+   set(SWIFT_LIBDISPATCH_C_COMPILER ${CMAKE_C_COMPILER})
+   set(SWIFT_LIBDISPATCH_CXX_COMPILER ${CMAKE_CXX_COMPILER})
+ elseif(${CMAKE_SYSTEM_NAME} STREQUAL ${CMAKE_HOST_SYSTEM_NAME})
+   set(SWIFT_LIBDISPATCH_C_COMPILER ${PATH_TO_CLANG_BUILD}/bin/clang)
+   set(SWIFT_LIBDISPATCH_CXX_COMPILER ${PATH_TO_CLANG_BUILD}/bin/clang++)
+ else()
+   message(SEND_ERROR "libdispatch requires a newer clang compiler (${CMAKE_C_COMPILER_VERSION} < 3.9)")
+ endif()
+
+  include(ExternalProject)
+  ExternalProject_Add(libdispatch
+                      SOURCE_DIR
+                        "${SWIFT_PATH_TO_LIBDISPATCH_SOURCE}"
+                      CMAKE_ARGS
+                        -DCMAKE_AR=${CMAKE_AR}
+                        -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+                        -DCMAKE_C_COMPILER=${SWIFT_LIBDISPATCH_C_COMPILER}
+                        -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS}
+                        -DCMAKE_CXX_COMPILER=${SWIFT_LIBDISPATCH_CXX_COMPILER}
+                        -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
+                        -DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}
+                        -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
+                        -DCMAKE_LINKER=${CMAKE_LINKER}
+                        -DCMAKE_RANLIB=${CMAKE_RANLIB}
+                        -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}
+                        -DENABLE_SWIFT=NO
+                        -DENABLE_TESTING=NO
+                      INSTALL_COMMAND
+                        # NOTE(compnerd) provide a custom install command to
+                        # ensure that we strip out the DESTDIR environment
+                        # from the sub-build
+                        ${CMAKE_COMMAND} -E env --unset=DESTDIR ${CMAKE_COMMAND} --build . --target install
+                      STEP_TARGETS
+                        install
+                      BUILD_BYPRODUCTS
+                        <INSTALL_DIR>/lib/${CMAKE_SHARED_LIBRARY_PREFIX}dispatch${CMAKE_SHARED_LIBRARY_SUFFIX}
+                        <INSTALL_DIR>/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}dispatch${CMAKE_IMPORT_LIBRARY_SUFFIX}
+                        <INSTALL_DIR>/lib/${CMAKE_SHARED_LIBRARY_PREFIX}BlocksRuntime${CMAKE_SHARED_LIBRARY_SUFFIX}
+                        <INSTALL_DIR>/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}BlocksRuntime${CMAKE_IMPORT_LIBRARY_SUFFIX}
+                      BUILD_ALWAYS
+                        1)
+
+  ExternalProject_Get_Property(libdispatch install_dir)
+
+  # CMake does not like the addition of INTERFACE_INCLUDE_DIRECTORIES without
+  # the directory existing.  Just create the location which will be populated
+  # during the installation.
+  file(MAKE_DIRECTORY ${install_dir}/include)
+
+  add_library(dispatch SHARED IMPORTED)
+  set_target_properties(dispatch
+                        PROPERTIES
+                          IMPORTED_LOCATION
+                            ${install_dir}/lib/${CMAKE_SHARED_LIBRARY_PREFIX}dispatch${CMAKE_SHARED_LIBRARY_SUFFIX}
+                          IMPORTED_IMPLIB
+                            ${install_dir}/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}dispatch${CMAKE_IMPORT_LIBRARY_SUFFIX}
+                          INTERFACE_INCLUDE_DIRECTORIES
+                            ${install_dir}/include)
+
+  add_library(BlocksRuntime SHARED IMPORTED)
+  set_target_properties(BlocksRuntime
+                        PROPERTIES
+                          IMPORTED_LOCATION
+                            ${install_dir}/lib/${CMAKE_SHARED_LIBRARY_PREFIX}BlocksRuntime${CMAKE_SHARED_LIBRARY_SUFFIX}
+                          IMPORTED_IMPLIB
+                            ${install_dir}/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}BlocksRuntime${CMAKE_IMPORT_LIBRARY_SUFFIX}
+                          INTERFACE_INCLUDE_DIRECTORIES
+                            ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE}/src/BlocksRuntime)
+
+  add_dependencies(dispatch libdispatch-install)
+  add_dependencies(BlocksRuntime libdispatch-install)
+
+  swift_install_in_component(sourcekit-inproc
+                             FILES
+                               $<TARGET_FILE:dispatch>
+                               $<TARGET_FILE:BlocksRuntime>
+                             DESTINATION
+                               lib${LLVM_LIBDIR_SUFFIX})
+
+  # FIXME(compnerd) this should be taken care of by the
+  # INTERFACE_INCLUDE_DIRECTORIES above
+  include_directories(AFTER
+                        ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE}/src/BlocksRuntime
+                        ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE})
+endif()
+
 #
 # Set up global CMake variables for API notes.
 #

cmake/modules/AddSwiftBlocksSupport.cmake

@@ -0,0 +1,19 @@
+# Adds blocks support in a cross platform manner.
+function(swift_add_blocks_support target_name)
+  if(NOT "${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
+    set(c_compile_flags)
+    # TODO(compnerd) this should really use target_compile_options but the use
+    # of keyword and non-keyword flags prevents this
+    if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+      list(APPEND c_compile_flags -fblocks)
+    elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+      if(SWIFT_COMPILER_IS_MSVC_LIKE)
+        list(APPEND c_compile_flags -Xclang;-fblocks)
+      else()
+        list(APPEND c_compile_flags -fblocks)
+      endif()
+    endif()
+    set_property(TARGET ${target_name} APPEND_STRING PROPERTY
+        COMPILE_FLAGS " ${c_compile_flags}")
+  endif()
+endfunction()

tools/SourceKit/CMakeLists.txt

@@ -97,97 +97,6 @@ include_directories(BEFORE
 
 if(NOT "${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
   string(TOUPPER "${CMAKE_SYSTEM_NAME}" SOURCEKIT_DEFAULT_TARGET_SDK)
-  set(SOURCEKIT_NEED_EXPLICIT_LIBDISPATCH TRUE)
-
-  if(SWIFT_BUILD_SOURCEKIT)
-    if(CMAKE_C_COMPILER_ID STREQUAL Clang AND
-       CMAKE_C_COMPILER_VERSION VERSION_GREATER 3.8
-       OR LLVM_USE_SANITIZER)
-     set(SWIFT_SOURCEKIT_C_COMPILER ${CMAKE_C_COMPILER})
-     set(SWIFT_SOURCEKIT_CXX_COMPILER ${CMAKE_CXX_COMPILER})
-   elseif(${CMAKE_SYSTEM_NAME} STREQUAL ${CMAKE_HOST_SYSTEM_NAME})
-     set(SWIFT_SOURCEKIT_C_COMPILER ${PATH_TO_CLANG_BUILD}/bin/clang)
-     set(SWIFT_SOURCEKIT_CXX_COMPILER ${PATH_TO_CLANG_BUILD}/bin/clang++)
-   else()
-     message(SEND_ERROR "libdispatch requires a newer clang compiler (${CMAKE_C_COMPILER_VERSION} < 3.9)")
-   endif()
-
-    include(ExternalProject)
-    ExternalProject_Add(libdispatch
-                        SOURCE_DIR
-                          "${SWIFT_PATH_TO_LIBDISPATCH_SOURCE}"
-                        CMAKE_ARGS
-                          -DCMAKE_AR=${CMAKE_AR}
-                          -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-                          -DCMAKE_C_COMPILER=${SWIFT_SOURCEKIT_C_COMPILER}
-                          -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS}
-                          -DCMAKE_CXX_COMPILER=${SWIFT_SOURCEKIT_CXX_COMPILER}
-                          -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
-                          -DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}
-                          -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
-                          -DCMAKE_LINKER=${CMAKE_LINKER}
-                          -DCMAKE_RANLIB=${CMAKE_RANLIB}
-                          -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}
-                          -DENABLE_SWIFT=NO
-                          -DENABLE_TESTING=NO
-                        INSTALL_COMMAND
-                          # NOTE(compnerd) provide a custom install command to
-                          # ensure that we strip out the DESTDIR environment
-                          # from the sub-build
-                          ${CMAKE_COMMAND} -E env --unset=DESTDIR ${CMAKE_COMMAND} --build . --target install
-                        STEP_TARGETS
-                          install
-                        BUILD_BYPRODUCTS
-                          <INSTALL_DIR>/lib/${CMAKE_SHARED_LIBRARY_PREFIX}dispatch${CMAKE_SHARED_LIBRARY_SUFFIX}
-                          <INSTALL_DIR>/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}dispatch${CMAKE_IMPORT_LIBRARY_SUFFIX}
-                          <INSTALL_DIR>/lib/${CMAKE_SHARED_LIBRARY_PREFIX}BlocksRuntime${CMAKE_SHARED_LIBRARY_SUFFIX}
-                          <INSTALL_DIR>/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}BlocksRuntime${CMAKE_IMPORT_LIBRARY_SUFFIX}
-                        BUILD_ALWAYS
-                          1)
-
-    ExternalProject_Get_Property(libdispatch install_dir)
-
-    # CMake does not like the addition of INTERFACE_INCLUDE_DIRECTORIES without
-    # the directory existing.  Just create the location which will be populated
-    # during the installation.
-    file(MAKE_DIRECTORY ${install_dir}/include)
-
-    add_library(dispatch SHARED IMPORTED)
-    set_target_properties(dispatch
-                          PROPERTIES
-                            IMPORTED_LOCATION
-                              ${install_dir}/lib/${CMAKE_SHARED_LIBRARY_PREFIX}dispatch${CMAKE_SHARED_LIBRARY_SUFFIX}
-                            IMPORTED_IMPLIB
-                              ${install_dir}/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}dispatch${CMAKE_IMPORT_LIBRARY_SUFFIX}
-                            INTERFACE_INCLUDE_DIRECTORIES
-                              ${install_dir}/include)
-
-    add_library(BlocksRuntime SHARED IMPORTED)
-    set_target_properties(BlocksRuntime
-                          PROPERTIES
-                            IMPORTED_LOCATION
-                              ${install_dir}/lib/${CMAKE_SHARED_LIBRARY_PREFIX}BlocksRuntime${CMAKE_SHARED_LIBRARY_SUFFIX}
-                            IMPORTED_IMPLIB
-                              ${install_dir}/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}BlocksRuntime${CMAKE_IMPORT_LIBRARY_SUFFIX}
-                            INTERFACE_INCLUDE_DIRECTORIES
-                              ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE}/src/BlocksRuntime)
-
-    add_dependencies(dispatch libdispatch-install)
-    add_dependencies(BlocksRuntime libdispatch-install)
-
-    swift_install_in_component(sourcekit-inproc
-                               FILES
-                                 $<TARGET_FILE:dispatch>
-                                 $<TARGET_FILE:BlocksRuntime>
-                               DESTINATION
-                                 lib${LLVM_LIBDIR_SUFFIX})
-
-    # FIXME(compnerd) this should be taken care of by the
-    # INTERFACE_INCLUDE_DIRECTORIES above
-    include_directories(AFTER
-                          ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE}/src/BlocksRuntime
-                          ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE})
-  endif()
 endif()
 
 add_subdirectory(include)

tools/SourceKit/cmake/modules/AddSwiftSourceKit.cmake

@@ -1,3 +1,4 @@
+include(AddSwiftBlocksSupport)
 
 function(add_sourcekit_symbol_exports target_name export_file)
   # Makefile.rules contains special cases for different platforms.
@@ -68,18 +69,6 @@ function(add_sourcekit_default_compiler_flags target)
     ANALYZE_CODE_COVERAGE "${analyze_code_coverage}"
     RESULT_VAR_NAME link_flags)
 
-  # TODO(compnerd) this should really use target_compile_options but the use
-  # of keyword and non-keyword flags prevents this
-  if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
-    list(APPEND c_compile_flags -fblocks)
-  elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
-    if(SWIFT_COMPILER_IS_MSVC_LIKE)
-      list(APPEND c_compile_flags -Xclang;-fblocks)
-    else()
-      list(APPEND c_compile_flags -fblocks)
-    endif()
-  endif()
-
   # Convert variables to space-separated strings.
   _list_escape_for_shell("${c_compile_flags}" c_compile_flags)
   _list_escape_for_shell("${link_flags}" link_flags)
@@ -89,6 +78,7 @@ function(add_sourcekit_default_compiler_flags target)
       COMPILE_FLAGS " ${c_compile_flags}")
   set_property(TARGET "${target}" APPEND_STRING PROPERTY
       LINK_FLAGS " ${link_flags}")
+  swift_add_blocks_support("${target}")
 endfunction()
 
 # Add a new SourceKit library.

tools/SourceKit/lib/Support/CMakeLists.txt

@@ -12,7 +12,7 @@ add_sourcekit_library(SourceKitSupport
   ${SourceKitSupport_sources}
   LINK_LIBS swiftBasic swiftSyntax clangBasic clangRewrite
 )
-if(SOURCEKIT_NEED_EXPLICIT_LIBDISPATCH)
+if(SWIFT_NEED_EXPLICIT_LIBDISPATCH)
   target_link_libraries(SourceKitSupport INTERFACE dispatch BlocksRuntime)
 endif()
 

tools/SourceKit/tools/complete-test/CMakeLists.txt

@@ -9,7 +9,7 @@ add_sourcekit_executable(complete-test
   LINK_LIBS ${SOURCEKITD_TEST_LINK_LIBS}
   LLVM_COMPONENT_DEPENDS support option coverage lto
 )
-if(SOURCEKIT_NEED_EXPLICIT_LIBDISPATCH)
+if(SWIFT_NEED_EXPLICIT_LIBDISPATCH)
   target_link_libraries(complete-test PRIVATE dispatch BlocksRuntime)
 endif()
 

tools/SourceKit/tools/sourcekitd-repl/CMakeLists.txt

@@ -13,7 +13,7 @@ if(HAVE_UNICODE_LIBEDIT)
     LINK_LIBS ${SOURCEKITD_REPL_LINK_LIBS} edit
     LLVM_COMPONENT_DEPENDS support coverage lto
   )
-  if(SOURCEKIT_NEED_EXPLICIT_LIBDISPATCH)
+  if(SWIFT_NEED_EXPLICIT_LIBDISPATCH)
     target_link_libraries(sourcekitd-repl PRIVATE dispatch BlocksRuntime)
   endif()
 

tools/SourceKit/tools/sourcekitd-test/CMakeLists.txt

@@ -15,7 +15,7 @@ add_sourcekit_executable(sourcekitd-test
     clangRewrite clangLex clangBasic
   LLVM_COMPONENT_DEPENDS core support option coverage lto
 )
-if(SOURCEKIT_NEED_EXPLICIT_LIBDISPATCH)
+if(SWIFT_NEED_EXPLICIT_LIBDISPATCH)
   target_link_libraries(sourcekitd-test PRIVATE dispatch BlocksRuntime)
 endif()