[infra] wipe out global include_directories (#482)

* [cmake] trim and style Utils.cmake * oodles * public_headers for translations * remove comment * remove comments
maliput · Jun 26, 2018 · 22c48a1 · 22c48a1
1 parent ec26ba7
commit 22c48a1
Show file tree

Hide file tree

Showing 23 changed files with 173 additions and 293 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,114 +1,85 @@
-cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
+##############################################################################
+# Project
+##############################################################################
 
+cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
 project(delphyne LANGUAGES CXX VERSION 3.0.0)
 
-set (project_cmake_dir ${PROJECT_SOURCE_DIR}/cmake
-  CACHE PATH "Location of CMake scripts")
+##############################################################################
+# CMake Support
+##############################################################################
 
-include (${project_cmake_dir}/Utils.cmake)
+# Useful string/list macros
+include (${PROJECT_SOURCE_DIR}/cmake/Utils.cmake)
 
-# Use GNUInstallDirst to get canonical paths
+# Set CMAKE_INSTALL_<INCLUDEDIR|BINDIR|LIBDIR>
 include(GNUInstallDirs)
 
-set (CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE ON)
-
-# developer's option to cache PKG_CONFIG_PATH and
-# LD_LIBRARY_PATH for local installs
-if(PKG_CONFIG_PATH)
-  set (ENV{PKG_CONFIG_PATH} ${PKG_CONFIG_PATH}:$ENV{PKG_CONFIG_PATH})
-endif()
-if(LD_LIBRARY_PATH)
-  set (ENV{LD_LIBRARY_PATH} ${LD_LIBRARY_PATH}:$ENV{LD_LIBRARY_PATH})
-endif()
-
-set (USE_FULL_RPATH OFF CACHE BOOL "Set to true to enable full rpath")
-
-if (USE_FULL_RPATH)
-  # use, i.e. don't skip the full RPATH for the build tree
-  set(CMAKE_SKIP_BUILD_RPATH  FALSE)
-
-  # when building, don't use the install RPATH already
-  # (but later on when installing)
-  set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
-
-  set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}")
-
-  # add the automatically determined parts of the RPATH
-  # which point to directories outside the build tree to the install RPATH
-  set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
-
-  # the RPATH to be used when installing, but only if its not a system directory
-  list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}" isSystemDir)
-  if("${isSystemDir}" STREQUAL "-1")
-    set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}")
-  endif("${isSystemDir}" STREQUAL "-1")
-endif()
+##############################################################################
+# Uninstall Target
+##############################################################################
 
-set (BUILD_DELPHYNE ON CACHE INTERNAL
-  "Build Delphyne" FORCE)
-set (build_errors "" CACHE INTERNAL "build errors" FORCE)
-set (build_warnings "" CACHE INTERNAL "build warnings" FORCE)
+configure_file(
+  "${PROJECT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
+  "${PROJECT_BINARY_DIR}/cmake/cmake_uninstall.cmake"
+  IMMEDIATE @ONLY)
+add_custom_target(uninstall
+  "${CMAKE_COMMAND}" -P
+  "${PROJECT_BINARY_DIR}/cmake/cmake_uninstall.cmake")
 
 ##############################################################################
 # Find 3rd Party Packages
 ##############################################################################
 
-message (STATUS "\n\n====== Finding 3rd Party Packages ======\n")
+message(STATUS "\n\n====== Finding 3rd Party Packages ======\n")
 
 find_package(drake REQUIRED)
 find_package(ignition-common2 REQUIRED)
 find_package(ignition-math5 REQUIRED)
 find_package(ignition-msgs2 REQUIRED)
 find_package(ignition-transport5 REQUIRED)
 
-message (STATUS "\n----------------------------------------\n")
+##############################################################################
+# Project Configuration
+##############################################################################
+
+message(STATUS "\n\n========= Project Configuration ========\n")
+
+set(BUILD_SHARED_LIBS true)
+
+# Ugh, makefile generators don't set any configuration (build) types. Use GNU's
+set(DELPHYNE_CONFIGURATION_TYPES
+      ${CMAKE_CONFIGURATION_TYPES} Debug MinSizeRel Release RelWithDebInfo)
+list(REMOVE_DUPLICATES DELPHYNE_CONFIGURATION_TYPES)
+
+if(NOT CMAKE_BUILD_TYPE)
+  message(STATUS "Setting build type to 'RelWithDebInfo' as none was specified.")
+  set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE
+    STRING "Choose the type of build." FORCE)
+  # Set the possible values of build type for cmake-gui
+  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
+    ${DELPHYNE_CONFIGURATION_TYPES})
+endif()
+
+if(NOT ${CMAKE_BUILD_TYPE} IN_LIST DELPHYNE_CONFIGURATION_TYPES)
+  message(
+    FATAL_ERROR
+      "Build type '${CMAKE_BUILD_TYPE}' unknown. "
+      "Valid options are: ${DELPHYNE_CONFIGURATION_TYPES}.")
+endif()
 
-#####################################
-MESSAGE(STATUS "Checking build type")
-# Set the default build type
-if (NOT CMAKE_BUILD_TYPE)
-    set (CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING
-        "Choose the type of build, options are: Debug Release RelWithDebInfo Profile Check" FORCE)
-endif (NOT CMAKE_BUILD_TYPE)
 # TODO: still convert to uppercase to keep backwards compatibility with
 # uppercase old supported and deprecated modes
 string(TOUPPER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE_UPPERCASE)
 
-set (BUILD_TYPE_PROFILE FALSE)
-set (BUILD_TYPE_RELEASE FALSE)
-set (BUILD_TYPE_RELWITHDEBINFO FALSE)
-set (BUILD_TYPE_DEBUG FALSE)
-
-if ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "PROFILE")
-  set (BUILD_TYPE_PROFILE TRUE)
-elseif ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "RELEASE")
-  set (BUILD_TYPE_RELEASE TRUE)
-elseif ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "RELWITHDEBINFO")
-  set (BUILD_TYPE_RELWITHDEBINFO TRUE)
-elseif ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "DEBUG")
-  set (BUILD_TYPE_DEBUG TRUE)
-else()
-  build_error("CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} unknown. Valid options are: Debug Release RelWithDebInfo Profile Check")
-endif()
-
 #####################################
 # Handle CFlags
+
 unset (CMAKE_C_FLAGS_ALL CACHE)
 unset (CMAKE_CXX_FLAGS CACHE)
 
-# USE_HOST_CFLAGS (default TRUE)
-# Will check building host machine for proper cflags
-if(NOT DEFINED USE_HOST_CFLAGS OR USE_HOST_CFLAGS)
-  message(STATUS "Enable host CFlags")
-  include (${project_cmake_dir}/HostCFlags.cmake)
-endif()
-
-# USE_UPSTREAM_CFLAGS (default TRUE)
-# Will use predefined delphyne developers cflags
-if(NOT DEFINED USE_UPSTREAM_CFLAGS OR USE_UPSTREAM_CFLAGS)
-  message(STATUS "Enable upstream CFlags")
-  include(${project_cmake_dir}/DefaultCFlags.cmake)
-endif()
+include(${PROJECT_SOURCE_DIR}/cmake/HostCFlags.cmake)
+include(${PROJECT_SOURCE_DIR}/cmake/DefaultCFlags.cmake)
 
 # Check if warning options are avaliable for the compiler and return WARNING_CXX_FLAGS variable
 list(APPEND WARN_LEVEL -Waddress -Warray-bounds -Wcomment -Wformat -Wnonnull)
@@ -125,109 +96,66 @@ filter_valid_compiler_warnings(${WARN_LEVEL} -Wextra -Wno-long-long
   -Wno-unused-value -Wno-unused-value -Wno-unused-value -Wno-unused-value
   -Winit-self -Wswitch-default
   -Wmissing-include-dirs -Wno-pragmas)
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}${WARNING_CXX_FLAGS} ${UNFILTERED_FLAGS}")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}${WARNING_CXX_FLAGS} ${UNFILTERED_FLAGS}")
+
+# Report out
+message(STATUS "Shared Libraries..............${BUILD_SHARED_LIBS}")
+message(STATUS "Build Type....................${CMAKE_BUILD_TYPE}")
+message(STATUS "Install path..................${CMAKE_INSTALL_PREFIX}")
+if (DEFINED CMAKE_CXX_FLAGS)
+  message(STATUS "Custom CFlags.................${CMAKE_CXX_FLAGS}")
+else()
+  message (STATUS "Using default CFlags")
+endif()
 
-set(BUILD_SHARED_LIBS TRUE)
+message(STATUS "\n----------------------------------------\n")
 
-#################################################
-# Print warnings and errors
-if ( build_warnings )
-  message(STATUS "BUILD WARNINGS")
-  foreach (msg ${build_warnings})
-    message(STATUS ${msg})
-  endforeach ()
-  message(STATUS "END BUILD WARNINGS\n")
-endif (build_warnings)
+##############################################################################
+# Sources
+##############################################################################
 
-########### Add uninstall target ###############
-configure_file(
-  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
-  "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake"
-  IMMEDIATE @ONLY)
-add_custom_target(uninstall
-  "${CMAKE_COMMAND}" -P
-  "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake")
-
-if (build_errors)
-  message(STATUS "BUILD ERRORS: These must be resolved before compiling.")
-  foreach (msg ${build_errors})
-    message(STATUS ${msg})
-  endforeach ()
-  message(STATUS "END BUILD ERRORS\n")
-  message (FATAL_ERROR "Errors encountered in build. "
-      "Please see the BUILD ERRORS above.")
-else (build_errors)
-
-  include_directories(
-    ${CMAKE_SOURCE_DIR}
-    ${PROJECT_BINARY_DIR}
-  )
-
-  link_directories(${PROJECT_BINARY_DIR}/src)
-
-  if (DEFINED CMAKE_CXX_FLAGS)
-    message (STATUS "Custom CFlags:${CMAKE_CXX_FLAGS}")
-  else()
-    message (STATUS "Use default CFlags")
-  endif()
-  message (STATUS "Build Type: ${CMAKE_BUILD_TYPE}")
-  message (STATUS "Install path: ${CMAKE_INSTALL_PREFIX}")
-
-  add_subdirectory(include)
-  add_subdirectory(src)
-  add_subdirectory(python)
-
-  ########################################
-  # Testing
-  if(NOT DEFINED BUILD_TESTING OR BUILD_TESTING)
-    enable_testing()
-    add_subdirectory(test)
-  endif()
-
-  ########################################
-  # Make the cmake config files
-
-  include(CMakePackageConfigHelpers)
-
-
-  ########################################
-  # Package Preparation
-
-  configure_package_config_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/cmake/${PROJECT_NAME}-config.cmake.in
-    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake
-    INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}/cmake
-  )
+add_subdirectory(include)
+add_subdirectory(src)
+add_subdirectory(python)
+
+##############################################################################
+# Tests
+##############################################################################
+
+# We always enable tests (that might change in the future)
+enable_testing()
+add_subdirectory(test)
 
-  # Version module
-  write_basic_config_version_file(
+##############################################################################
+# Export
+##############################################################################
+
+include(CMakePackageConfigHelpers)
+
+configure_package_config_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/cmake/${PROJECT_NAME}-config.cmake.in
+  ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}/cmake
+)
+
+# Version module
+write_basic_config_version_file(
+  ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake
+  VERSION ${PROJECT_VERSION}
+  COMPATIBILITY SameMajorVersion
+)
+
+# Install config, version and target modules
+install(
+  FILES
+    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake
     ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake
-    VERSION ${PROJECT_VERSION}
-    COMPATIBILITY SameMajorVersion
-  )
-
-  # Install config, version and target modules
-  install(
-    FILES
-      ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake
-      ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake
-    DESTINATION
-      ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}
-  )
-  install(
-    EXPORT ${PROJECT_NAME}-targets
-    NAMESPACE ${PROJECT_NAME}::
-    DESTINATION
-      ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}
-  )
-
-  ########################################
-  # If present, load platform-specific build hooks.  This system is used,
-  # for example, by the Ubuntu overlay, to arrange for installation of
-  # Ubuntu-specific application-launching configuration.
-  if (EXISTS ${PROJECT_SOURCE_DIR}/cmake/packager-hooks/CMakeLists.txt)
-    message(STATUS "Loading packager build hooks from cmake/packager-hooks")
-    add_subdirectory(cmake/packager-hooks)
-  endif()
-
-endif(build_errors)
+  DESTINATION
+    ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}
+)
+install(
+  EXPORT ${PROJECT_NAME}-targets
+  NAMESPACE ${PROJECT_NAME}::
+  DESTINATION
+    ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}
+)
diff --git a/cmake/FindSSE.cmake b/cmake/FindSSE.cmake
@@ -1,4 +1,4 @@
-# Check if SSE instructions are available on the machine where 
+# Check if SSE instructions are available on the machine where
 # the project is compiled.
 
 EXEC_PROGRAM(cat ARGS "/proc/cpuinfo" OUTPUT_VARIABLE CPUINFO)
@@ -52,6 +52,7 @@ set(SSE2_FOUND   true  CACHE BOOL "SSE2 available on host")
 set(SSE3_FOUND   false CACHE BOOL "SSE3 available on host")
 set(SSSE3_FOUND  false CACHE BOOL "SSSE3 available on host")
 set(SSE4_1_FOUND false CACHE BOOL "SSE4.1 available on host")
+set(SSE4_2_FOUND false CACHE BOOL "SSE4.2 available on host")
 
 if(NOT SSE2_FOUND)
       MESSAGE(STATUS "Could not find hardware support for SSE2 on this machine.")
@@ -65,5 +66,8 @@ endif(NOT SSSE3_FOUND)
 if(NOT SSE4_1_FOUND)
       MESSAGE(STATUS "Could not find hardware support for SSE4.1 on this machine.")
 endif(NOT SSE4_1_FOUND)
+if(NOT SSE4_2_FOUND)
+      MESSAGE(STATUS "Could not find hardware support for SSE4.2 on this machine.")
+endif(NOT SSE4_2_FOUND)
 
-mark_as_advanced(SSE2_FOUND SSE3_FOUND SSSE3_FOUND SSE4_1_FOUND)
+mark_as_advanced(SSE2_FOUND SSE3_FOUND SSSE3_FOUND SSE4_1_FOUND SSE4_2_FOUND)
diff --git a/cmake/HostCFlags.cmake b/cmake/HostCFlags.cmake
@@ -1,4 +1,4 @@
-include (${project_cmake_dir}/FindSSE.cmake)
+include (${PROJECT_SOURCE_DIR}/cmake/FindSSE.cmake)
 
 if (SSE2_FOUND)
   set (CMAKE_C_FLAGS_ALL "-msse -msse2 ${CMAKE_C_FLAGS_ALL}")

diff --git a/cmake/Python.cmake b/cmake/Python.cmake
@@ -12,12 +12,4 @@ set(PYTHON_INSTALL_DIR lib/python${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}
 if(NOT PYBIND11_PYTHON_VERSION)
   set(PYBIND11_PYTHON_VERSION "2.7" CACHE STRING "Python version to use for compiling modules")
 endif()
-find_package(pybind11)
-if (NOT pybind11_FOUND)
-  BUILD_ERROR("Missing: pybind11")
-endif()
-
-# TODO(mikaelarguedas) uncomment this once we switch to python3
-# if (NOT PYTHON_MODULE_EXTENSION MATCHES "cpython")
-#   BUILD_ERROR("pybind didn't find a cpython interpreter: ${PYTHON_MODULE_EXTENSION}")
-# endif()
+find_package(pybind11 REQUIRED)