CheckIncludeFiles.cmake 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. # file Copyright.txt or https://cmake.org/licensing for details.
  3. #[=======================================================================[.rst:
  4. CheckIncludeFiles
  5. -----------------
  6. Provides a macro to check if a list of one or more header files can
  7. be included together.
  8. .. command:: CHECK_INCLUDE_FILES
  9. .. code-block:: cmake
  10. CHECK_INCLUDE_FILES("<includes>" <variable> [LANGUAGE <language>])
  11. Check if the given ``<includes>`` list may be included together
  12. in a source file and store the result in an internal cache
  13. entry named ``<variable>``. Specify the ``<includes>`` argument
  14. as a :ref:`;-list <CMake Language Lists>` of header file names.
  15. If ``LANGUAGE`` is set, the specified compiler will be used to perform the
  16. check. Acceptable values are ``C`` and ``CXX``. If not set, the C compiler
  17. will be used if enabled. If the C compiler is not enabled, the C++
  18. compiler will be used if enabled.
  19. The following variables may be set before calling this macro to modify
  20. the way the check is run:
  21. ``CMAKE_REQUIRED_FLAGS``
  22. string of compile command line flags.
  23. ``CMAKE_REQUIRED_DEFINITIONS``
  24. a :ref:`;-list <CMake Language Lists>` of macros to define (-DFOO=bar).
  25. ``CMAKE_REQUIRED_INCLUDES``
  26. a :ref:`;-list <CMake Language Lists>` of header search paths to pass to
  27. the compiler.
  28. ``CMAKE_REQUIRED_LINK_OPTIONS``
  29. a :ref:`;-list <CMake Language Lists>` of options to add to the link command.
  30. ``CMAKE_REQUIRED_LIBRARIES``
  31. a :ref:`;-list <CMake Language Lists>` of libraries to add to the link
  32. command. See policy :policy:`CMP0075`.
  33. ``CMAKE_REQUIRED_QUIET``
  34. execute quietly without messages.
  35. See modules :module:`CheckIncludeFile` and :module:`CheckIncludeFileCXX`
  36. to check for a single header file in ``C`` or ``CXX`` languages.
  37. #]=======================================================================]
  38. include_guard(GLOBAL)
  39. macro(CHECK_INCLUDE_FILES INCLUDE VARIABLE)
  40. if(NOT DEFINED "${VARIABLE}")
  41. set(CMAKE_CONFIGURABLE_FILE_CONTENT "/* */\n")
  42. if("x${ARGN}" STREQUAL "x")
  43. if(CMAKE_C_COMPILER_LOADED)
  44. set(_lang C)
  45. elseif(CMAKE_CXX_COMPILER_LOADED)
  46. set(_lang CXX)
  47. else()
  48. message(FATAL_ERROR "CHECK_INCLUDE_FILES needs either C or CXX language enabled.\n")
  49. endif()
  50. elseif("x${ARGN}" MATCHES "^xLANGUAGE;([a-zA-Z]+)$")
  51. set(_lang "${CMAKE_MATCH_1}")
  52. elseif("x${ARGN}" MATCHES "^xLANGUAGE$")
  53. message(FATAL_ERROR "No languages listed for LANGUAGE option.\nSupported languages: C, CXX.\n")
  54. else()
  55. message(FATAL_ERROR "Unknown arguments:\n ${ARGN}\n")
  56. endif()
  57. if(_lang STREQUAL "C")
  58. set(src ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CheckIncludeFiles/${VARIABLE}.c)
  59. elseif(_lang STREQUAL "CXX")
  60. set(src ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CheckIncludeFiles/${VARIABLE}.cpp)
  61. else()
  62. message(FATAL_ERROR "Unknown language:\n ${_lang}\nSupported languages: C, CXX.\n")
  63. endif()
  64. if(CMAKE_REQUIRED_INCLUDES)
  65. set(CHECK_INCLUDE_FILES_INCLUDE_DIRS "-DINCLUDE_DIRECTORIES=${CMAKE_REQUIRED_INCLUDES}")
  66. else()
  67. set(CHECK_INCLUDE_FILES_INCLUDE_DIRS)
  68. endif()
  69. set(CHECK_INCLUDE_FILES_CONTENT "/* */\n")
  70. set(MACRO_CHECK_INCLUDE_FILES_FLAGS ${CMAKE_REQUIRED_FLAGS})
  71. foreach(FILE ${INCLUDE})
  72. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT
  73. "#include <${FILE}>\n")
  74. endforeach()
  75. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT
  76. "\n\nint main(void){return 0;}\n")
  77. configure_file("${CMAKE_ROOT}/Modules/CMakeConfigurableFile.in"
  78. "${src}" @ONLY)
  79. set(_INCLUDE ${INCLUDE}) # remove empty elements
  80. if("${_INCLUDE}" MATCHES "^([^;]+);.+;([^;]+)$")
  81. list(LENGTH _INCLUDE _INCLUDE_LEN)
  82. set(_description "${_INCLUDE_LEN} include files ${CMAKE_MATCH_1}, ..., ${CMAKE_MATCH_2}")
  83. elseif("${_INCLUDE}" MATCHES "^([^;]+);([^;]+)$")
  84. set(_description "include files ${CMAKE_MATCH_1}, ${CMAKE_MATCH_2}")
  85. else()
  86. set(_description "include file ${_INCLUDE}")
  87. endif()
  88. set(_CIF_LINK_OPTIONS)
  89. if(CMAKE_REQUIRED_LINK_OPTIONS)
  90. set(_CIF_LINK_OPTIONS LINK_OPTIONS ${CMAKE_REQUIRED_LINK_OPTIONS})
  91. endif()
  92. set(_CIF_LINK_LIBRARIES "")
  93. if(CMAKE_REQUIRED_LIBRARIES)
  94. cmake_policy(GET CMP0075 _CIF_CMP0075
  95. PARENT_SCOPE # undocumented, do not use outside of CMake
  96. )
  97. if("x${_CIF_CMP0075}x" STREQUAL "xNEWx")
  98. set(_CIF_LINK_LIBRARIES LINK_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES})
  99. elseif("x${_CIF_CMP0075}x" STREQUAL "xOLDx")
  100. elseif(NOT _CIF_CMP0075_WARNED)
  101. set(_CIF_CMP0075_WARNED 1)
  102. message(AUTHOR_WARNING
  103. "Policy CMP0075 is not set: Include file check macros honor CMAKE_REQUIRED_LIBRARIES. "
  104. "Run \"cmake --help-policy CMP0075\" for policy details. "
  105. "Use the cmake_policy command to set the policy and suppress this warning."
  106. "\n"
  107. "CMAKE_REQUIRED_LIBRARIES is set to:\n"
  108. " ${CMAKE_REQUIRED_LIBRARIES}\n"
  109. "For compatibility with CMake 3.11 and below this check is ignoring it."
  110. )
  111. endif()
  112. unset(_CIF_CMP0075)
  113. endif()
  114. if(NOT CMAKE_REQUIRED_QUIET)
  115. message(STATUS "Looking for ${_description}")
  116. endif()
  117. try_compile(${VARIABLE}
  118. ${CMAKE_BINARY_DIR}
  119. ${src}
  120. COMPILE_DEFINITIONS ${CMAKE_REQUIRED_DEFINITIONS}
  121. ${_CIF_LINK_OPTIONS}
  122. ${_CIF_LINK_LIBRARIES}
  123. CMAKE_FLAGS
  124. -DCOMPILE_DEFINITIONS:STRING=${MACRO_CHECK_INCLUDE_FILES_FLAGS}
  125. "${CHECK_INCLUDE_FILES_INCLUDE_DIRS}"
  126. OUTPUT_VARIABLE OUTPUT)
  127. unset(_CIF_LINK_OPTIONS)
  128. unset(_CIF_LINK_LIBRARIES)
  129. if(${VARIABLE})
  130. if(NOT CMAKE_REQUIRED_QUIET)
  131. message(STATUS "Looking for ${_description} - found")
  132. endif()
  133. set(${VARIABLE} 1 CACHE INTERNAL "Have include ${INCLUDE}")
  134. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
  135. "Determining if files ${INCLUDE} "
  136. "exist passed with the following output:\n"
  137. "${OUTPUT}\n\n")
  138. else()
  139. if(NOT CMAKE_REQUIRED_QUIET)
  140. message(STATUS "Looking for ${_description} - not found")
  141. endif()
  142. set(${VARIABLE} "" CACHE INTERNAL "Have includes ${INCLUDE}")
  143. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
  144. "Determining if files ${INCLUDE} "
  145. "exist failed with the following output:\n"
  146. "${OUTPUT}\nSource:\n${CMAKE_CONFIGURABLE_FILE_CONTENT}\n")
  147. endif()
  148. endif()
  149. endmacro()