Merge 'develop' into 'master' for Hana version 1.2.0

Author: ldionne

.appveyor.yml

@@ -5,7 +5,7 @@
 shallow_clone: true
 
 os:
-  - Visual Studio 2015 Update 2
+  - Visual Studio 2015
 
 build:
   verbosity: detailed
@@ -17,12 +17,6 @@ branches:
   except:
     - /pr\/.+/
 
-environment:
-  matrix:
-    - TESTS_ONLY: true
-    - EXAMPLES_ONLY: true
-
-
 install:
   ############################################################################
   # All external dependencies are installed in C:\projects\deps
@@ -42,7 +36,7 @@ install:
   ############################################################################
   # Install a recent CMake
   ############################################################################
-  - set CMAKE_URL="https://cmake.org/files/v3.7/cmake-3.7.2-win64-x64.zip"
+  - set CMAKE_URL="https://cmake.org/files/v3.8/cmake-3.8.0-win64-x64.zip"
   - appveyor DownloadFile %CMAKE_URL% -FileName cmake.zip
   - 7z x cmake.zip -oC:\projects\deps > nul
   - move C:\projects\deps\cmake-* C:\projects\deps\cmake # Move to a version-agnostic directory
@@ -64,6 +58,5 @@ before_build:
 build_script:
   - mkdir build
   - cd build
-  - cmake .. -GNinja -DCMAKE_CXX_COMPILER=clang-cl -DCMAKE_CXX_FLAGS="-fms-compatibility-version=19"
-  - if "%TESTS_ONLY%" == "true" (ninja tests && ctest -R --output-on-failure "test.+")
-  - if "%EXAMPLES_ONLY%" == "true" (ninja examples && ctest -R --output-on-failure "example.+")
+  - cmake .. -GNinja -DCMAKE_CXX_COMPILER=clang-cl
+  - cmake --build . --target check

.travis.yml

@@ -18,10 +18,6 @@ env:
     # ${GITHUB_TOKEN} environment variable.
     - secure: "gB1wvjk565j3O4UBGjyN44Vd8IGqcNHzkbvRdFNHp7C+C+JG2vhAeLlpiK0Zd483gdTjq9gPjIDwpwyG2UJ+yjT1kMTJvD1YNWpGcK6vOHYl1yMOwv/LBdnKn+J7i/FnoeULGRCCI2Fpp1qILhxeZgLxTxsdQaYXlAkkR0i8cgQ="
 
-  # Workaround for https://github.com/travis-ci/travis-ci/issues/4681
-  matrix:
-    - TRAVIS_EMPTY_JOB_WORKAROUND=true
-
 
 addons:
   apt:
@@ -46,9 +42,6 @@ cache:
 
 
 matrix:
-  exclude:
-    - env: TRAVIS_EMPTY_JOB_WORKAROUND=true
-
   include:
     ##########################################################################
     # Check for code formatting errors
@@ -229,15 +222,15 @@ install:
       if [[ -z "$(ls -A ${BOOST_DIR})" ]]; then
         if [[ "${BOOST_VERSION}" == "trunk" ]]; then
           BOOST_URL="http://github.com/boostorg/boost.git"
-          travis_retry git clone --depth 1 --recursive --quiet ${BOOST_URL} ${BOOST_DIR} || exit 1
-          (cd ${BOOST_DIR} && ./bootstrap.sh && ./b2 headers)
+          travis_retry git clone --depth 1 --recursive ${BOOST_URL} ${BOOST_DIR} || exit 1
+          (cd ${BOOST_DIR} && ./bootstrap.sh && ./b2 headers) || exit 1
         else
           BOOST_URL="http://sourceforge.net/projects/boost/files/boost/${BOOST_VERSION}/boost_${BOOST_VERSION//\./_}.tar.gz"
           mkdir -p ${BOOST_DIR}
-          { travis_retry wget --quiet -O - ${BOOST_URL} | tar --strip-components=1 -xz -C ${BOOST_DIR}; } || exit 1
+          { travis_retry wget -O - ${BOOST_URL} | tar --strip-components=1 -xz -C ${BOOST_DIR}; } || exit 1
         fi
         # Make sure we don't conflict with the Hana shipped with Boost
-        rm -rf ${BOOST_ROOT}/include/boost/{hana,hana.hpp}
+        rm -rf ${BOOST_DIR}/include/boost/{hana,hana.hpp} || exit 1
       fi
       CMAKE_OPTIONS+=" -DBOOST_ROOT=${BOOST_DIR}"
     fi
@@ -247,7 +240,7 @@ install:
   ############################################################################
   - |
     if [[ "${TRAVIS_OS_NAME}" == "linux" ]]; then
-      CMAKE_URL="https://cmake.org/files/v3.7/cmake-3.7.2-Linux-x86_64.tar.gz"
+      CMAKE_URL="https://cmake.org/files/v3.8/cmake-3.8.0-Linux-x86_64.tar.gz"
       mkdir cmake && travis_retry wget --no-check-certificate --quiet -O - ${CMAKE_URL} | tar --strip-components=1 -xz -C cmake
       export PATH=${DEPS_DIR}/cmake/bin:${PATH}
     else

CMakeLists.txt

@@ -2,7 +2,7 @@
 # Distributed under the Boost Software License, Version 1.0.
 # (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
 
-cmake_minimum_required(VERSION 3.7)
+cmake_minimum_required(VERSION 3.8)
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
 
@@ -28,24 +28,28 @@ include(CheckCxxCompilerSupport)
 
 
 ##############################################################################
-# Setup the 'hana' header-only library target.
+# Setup the 'hana' header-only library target, along with its install target
+# and exports.
 ##############################################################################
 add_library(hana INTERFACE)
-target_include_directories(hana INTERFACE include)
-
-include(CheckCXXCompilerFlag)
-# On Clang for Windows, -std=c++14 is not known, but -std=c++1y appears to work.
-if (MSVC AND ${CMAKE_CXX_COMPILER_ID} STREQUAL "Clang")
-    check_cxx_compiler_flag(-std=c++1y BOOST_HANA_HAS_STD_CPP1Y)
-    if (BOOST_HANA_HAS_STD_CPP1Y)
-        target_add_compile_options(hana INTERFACE -std=c++1y)
-    endif()
-else()
-    # TODO: Set these as interface properties when supported
-    set(CMAKE_CXX_STANDARD 14)
-    set(CMAKE_CXX_STANDARD_REQUIRED YES)
+target_include_directories(hana INTERFACE "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>"
+                                          $<INSTALL_INTERFACE:include>)
+# With Clang on Windows, the -std=c++14 flag is incorrectly set and the compiler
+# complains about the unkown option. TODO: Remove this workaround once the
+# underlying bug is fixed in CMake: https://gitlab.kitware.com/cmake/cmake/issues/17015
+if (NOT (MSVC AND ${CMAKE_CXX_COMPILER_ID} STREQUAL "Clang"))
+    target_compile_features(hana INTERFACE cxx_std_14)
 endif()
 
+# Export the `hana` library into a HanaConfig.cmake file
+install(TARGETS hana EXPORT HanaConfig)
+install(EXPORT HanaConfig       DESTINATION lib/cmake/hana)
+install(DIRECTORY include/boost DESTINATION include FILES_MATCHING PATTERN "*.hpp")
+
+# Also install an optional pkg-config file
+configure_file(cmake/hana.pc.in hana.pc @ONLY)
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/hana.pc" DESTINATION lib/pkgconfig)
+
 
 ##############################################################################
 # Setup CMake options
@@ -66,6 +70,7 @@ option(BOOST_HANA_ENABLE_EXCEPTIONS
 ##############################################################################
 # Function to setup common compiler flags on tests and examples
 ##############################################################################
+include(CheckCXXCompilerFlag)
 function(boost_hana_set_test_properties target)
     target_link_libraries(${target} PRIVATE hana)
     set_target_properties(${target} PROPERTIES CXX_EXTENSIONS NO)
@@ -110,17 +115,11 @@ endfunction()
 
 
 ##############################################################################
-# Setup include paths. More include paths can be added in subdirectories.
+# Look for the rest of Boost, which is an optional dependency of some tests.
 ##############################################################################
-include_directories(${Boost.Hana_SOURCE_DIR}/include)
-
 find_package(Boost 1.59)
-if (Boost_FOUND)
-    include_directories(${Boost_INCLUDE_DIRS})
-else()
-    message(WARNING
-        "The Boost library headers were not found; targets depending "
-        "on Boost won't be available.")
+if (NOT Boost_FOUND)
+    message(WARNING "The rest of Boost was not found; some tests and examples will be disabled.")
 endif()
 
 
@@ -142,9 +141,9 @@ function(boost_hana_target_name_for out file)
         set(_extension "${ARGV2}")
     endif()
 
-    file(RELATIVE_PATH _relative ${Boost.Hana_SOURCE_DIR} ${file})
-    string(REPLACE "${_extension}" "" _name ${_relative})
-    string(REGEX REPLACE "/" "." _name ${_name})
+    file(RELATIVE_PATH _relative "${Boost.Hana_SOURCE_DIR}" "${file}")
+    string(REPLACE "${_extension}" "" _name "${_relative}")
+    string(REGEX REPLACE "/" "." _name "${_name}")
     set(${out} "${_name}" PARENT_SCOPE)
 endfunction()
 
@@ -154,7 +153,7 @@ endfunction()
 ##############################################################################
 add_custom_target(check
     COMMAND ${CMAKE_CTEST_COMMAND} --output-on-failure
-    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
     COMMENT "Build and then run all the tests and examples.")
 
 
@@ -175,15 +174,3 @@ add_subdirectory(benchmark)
 add_subdirectory(doc)
 add_subdirectory(example)
 add_subdirectory(test)
-
-
-##############################################################################
-# Setup the 'install' target.
-# This copies the whole content of include/ to ${CMAKE_INSTALL_PREFIX}.
-##############################################################################
-install(DIRECTORY include/boost DESTINATION include
-        PATTERN ".DS_Store" EXCLUDE)
-
-# We also install an optional pkg-config file.
-configure_file(cmake/hana.pc.in hana.pc @ONLY)
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/hana.pc DESTINATION lib/pkgconfig)

README.md

@@ -173,10 +173,18 @@ Please see [LICENSE.md](LICENSE.md).
 ## Releasing
 This section acts as a reminder of the few simple steps required to release a
 new version of the library. This is only relevant to Hana's developers. To
-release a new version of the library, create an annotated tag using `git tag -a`.
+release a new version of the library, make sure the current version in
+`include/boost/hana/version.hpp` matches the release you're about to publish.
+Then, create an annotated tag with:
+```sh
+git tag -a --file=- v<version> <<EOM
+...your message here...
+EOM
+```
+
 Then, push the tag and create a new GitHub release pointing to that tag.
 Once that is done, bump the version number in `include/boost/hana/version.hpp`
-so that it matches the next planned release. Finally, do not forget to update
+so that it matches the next _planned_ release. Finally, do not forget to update
 the [Homebrew formula][] to point to the latest version.
 
 

benchmark/CMakeLists.txt

@@ -51,17 +51,20 @@ file(GLOB_RECURSE BOOST_HANA_BENCHMARKS *.erb.json)
 foreach(benchmark IN LISTS BOOST_HANA_BENCHMARKS)
     boost_hana_target_name_for(target ${benchmark} ".erb.json")
     get_filename_component(directory "${benchmark}" DIRECTORY)
-    file(GLOB cpp_files ${directory}/*.erb.cpp)
+    file(GLOB cpp_files "${directory}/*.erb.cpp")
     configure_file("${benchmark}" "${CMAKE_CURRENT_BINARY_DIR}/${target}.erb.json" @ONLY)
 
-    file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/${target}.measure.cpp "")
-    add_executable(${target}.measure EXCLUDE_FROM_ALL ${CMAKE_CURRENT_BINARY_DIR}/${target}.measure.cpp)
-    target_include_directories(${target}.measure PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+    file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/${target}.measure.cpp" "")
+    add_executable(${target}.measure EXCLUDE_FROM_ALL "${CMAKE_CURRENT_BINARY_DIR}/${target}.measure.cpp")
+    target_include_directories(${target}.measure PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}")
     if (MPL11_FOUND)
-        target_include_directories(${target}.measure PRIVATE ${MPL11_INCLUDE_DIR})
+        target_include_directories(${target}.measure PRIVATE "${MPL11_INCLUDE_DIR}")
     endif()
     if (Meta_FOUND)
-        target_include_directories(${target}.measure PRIVATE ${Meta_INCLUDE_DIR})
+        target_include_directories(${target}.measure PRIVATE "${Meta_INCLUDE_DIR}")
+    endif()
+    if (Boost_FOUND)
+        target_link_libraries(${target}.measure PRIVATE Boost::boost)
     endif()
     boost_hana_set_test_properties(${target}.measure)
     if (BOOST_HANA_HAS_FTEMPLATE_DEPTH)
@@ -72,13 +75,13 @@ foreach(benchmark IN LISTS BOOST_HANA_BENCHMARKS)
     add_custom_target(${target}.measure.run COMMAND ${target}.measure)
 
     add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${target}.json"
-        COMMAND ${RUBY_EXECUTABLE} -r tilt -r ${CMAKE_CURRENT_BINARY_DIR}/measure.rb
+        COMMAND ${RUBY_EXECUTABLE} -r tilt -r "${CMAKE_CURRENT_BINARY_DIR}/measure.rb"
             -e "MEASURE_FILE = '${CMAKE_CURRENT_BINARY_DIR}/${target}.measure.cpp'"
             -e "MEASURE_TARGET = '${target}.measure'"
             -e "json = Tilt::ERBTemplate.new('${CMAKE_CURRENT_BINARY_DIR}/${target}.erb.json').render"
             -e "File.open('${CMAKE_CURRENT_BINARY_DIR}/${target}.json', 'w') { |f| f.write(json) } "
         WORKING_DIRECTORY ${directory}
-        DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${target}.erb.json ${cpp_files}
+        DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${target}.erb.json" ${cpp_files}
         VERBATIM USES_TERMINAL
         COMMENT "Generating dataset for ${target}"
     )