CheckIncludeFiles.cmake 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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. #
  7. # Provides a macro to check if a list of one or more header files can
  8. # be included together.
  9. #
  10. # .. command:: CHECK_INCLUDE_FILES
  11. #
  12. # ::
  13. #
  14. # CHECK_INCLUDE_FILES("<includes>" <variable> [LANGUAGE <language>])
  15. #
  16. # Check if the given ``<includes>`` list may be included together
  17. # in a source file and store the result in an internal cache
  18. # entry named ``<variable>``. Specify the ``<includes>`` argument
  19. # as a :ref:`;-list <CMake Language Lists>` of header file names.
  20. #
  21. # If LANGUAGE is set, the specified compiler will be used to perform the
  22. # check. Acceptable values are ``C`` and ``CXX``. If not set, the C compiler
  23. # will be used if enabled. If the C compiler is not enabled, the C++
  24. # compiler will be used if enabled.
  25. #
  26. # The following variables may be set before calling this macro to modify
  27. # the way the check is run:
  28. #
  29. # ``CMAKE_REQUIRED_FLAGS``
  30. # string of compile command line flags
  31. # ``CMAKE_REQUIRED_DEFINITIONS``
  32. # list of macros to define (-DFOO=bar)
  33. # ``CMAKE_REQUIRED_INCLUDES``
  34. # list of include directories
  35. # ``CMAKE_REQUIRED_LIBRARIES``
  36. # list of libraries to link
  37. # ``CMAKE_REQUIRED_QUIET``
  38. # execute quietly without messages
  39. #
  40. # See modules :module:`CheckIncludeFile` and :module:`CheckIncludeFileCXX`
  41. # to check for a single header file in ``C`` or ``CXX`` languages.
  42. include_guard(GLOBAL)
  43. macro(CHECK_INCLUDE_FILES INCLUDE VARIABLE)
  44. if(NOT DEFINED "${VARIABLE}")
  45. set(CMAKE_CONFIGURABLE_FILE_CONTENT "/* */\n")
  46. if("x${ARGN}" STREQUAL "x")
  47. if(CMAKE_C_COMPILER_LOADED)
  48. set(_lang C)
  49. elseif(CMAKE_CXX_COMPILER_LOADED)
  50. set(_lang CXX)
  51. else()
  52. message(FATAL_ERROR "CHECK_INCLUDE_FILES needs either C or CXX language enabled.\n")
  53. endif()
  54. elseif("x${ARGN}" MATCHES "^xLANGUAGE;([a-zA-Z]+)$")
  55. set(_lang "${CMAKE_MATCH_1}")
  56. elseif("x${ARGN}" MATCHES "^xLANGUAGE$")
  57. message(FATAL_ERROR "No languages listed for LANGUAGE option.\nSupported languages: C, CXX.\n")
  58. else()
  59. message(FATAL_ERROR "Unknown arguments:\n ${ARGN}\n")
  60. endif()
  61. if(_lang STREQUAL "C")
  62. set(src ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CheckIncludeFiles/${VARIABLE}.c)
  63. elseif(_lang STREQUAL "CXX")
  64. set(src ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CheckIncludeFiles/${VARIABLE}.cpp)
  65. else()
  66. message(FATAL_ERROR "Unknown language:\n ${_lang}\nSupported languages: C, CXX.\n")
  67. endif()
  68. if(CMAKE_REQUIRED_INCLUDES)
  69. set(CHECK_INCLUDE_FILES_INCLUDE_DIRS "-DINCLUDE_DIRECTORIES=${CMAKE_REQUIRED_INCLUDES}")
  70. else()
  71. set(CHECK_INCLUDE_FILES_INCLUDE_DIRS)
  72. endif()
  73. set(CHECK_INCLUDE_FILES_CONTENT "/* */\n")
  74. set(MACRO_CHECK_INCLUDE_FILES_FLAGS ${CMAKE_REQUIRED_FLAGS})
  75. foreach(FILE ${INCLUDE})
  76. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT
  77. "#include <${FILE}>\n")
  78. endforeach()
  79. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT
  80. "\n\nint main(void){return 0;}\n")
  81. configure_file("${CMAKE_ROOT}/Modules/CMakeConfigurableFile.in"
  82. "${src}" @ONLY)
  83. set(_INCLUDE ${INCLUDE}) # remove empty elements
  84. if("${_INCLUDE}" MATCHES "^([^;]+);.+;([^;]+)$")
  85. list(LENGTH _INCLUDE _INCLUDE_LEN)
  86. set(_description "${_INCLUDE_LEN} include files ${CMAKE_MATCH_1}, ..., ${CMAKE_MATCH_2}")
  87. elseif("${_INCLUDE}" MATCHES "^([^;]+);([^;]+)$")
  88. set(_description "include files ${CMAKE_MATCH_1}, ${CMAKE_MATCH_2}")
  89. else()
  90. set(_description "include file ${_INCLUDE}")
  91. endif()
  92. if(NOT CMAKE_REQUIRED_QUIET)
  93. message(STATUS "Looking for ${_description}")
  94. endif()
  95. try_compile(${VARIABLE}
  96. ${CMAKE_BINARY_DIR}
  97. ${src}
  98. COMPILE_DEFINITIONS ${CMAKE_REQUIRED_DEFINITIONS}
  99. LINK_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES}
  100. CMAKE_FLAGS
  101. -DCOMPILE_DEFINITIONS:STRING=${MACRO_CHECK_INCLUDE_FILES_FLAGS}
  102. "${CHECK_INCLUDE_FILES_INCLUDE_DIRS}"
  103. OUTPUT_VARIABLE OUTPUT)
  104. if(${VARIABLE})
  105. if(NOT CMAKE_REQUIRED_QUIET)
  106. message(STATUS "Looking for ${_description} - found")
  107. endif()
  108. set(${VARIABLE} 1 CACHE INTERNAL "Have include ${INCLUDE}")
  109. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
  110. "Determining if files ${INCLUDE} "
  111. "exist passed with the following output:\n"
  112. "${OUTPUT}\n\n")
  113. else()
  114. if(NOT CMAKE_REQUIRED_QUIET)
  115. message(STATUS "Looking for ${_description} - not found")
  116. endif()
  117. set(${VARIABLE} "" CACHE INTERNAL "Have includes ${INCLUDE}")
  118. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
  119. "Determining if files ${INCLUDE} "
  120. "exist failed with the following output:\n"
  121. "${OUTPUT}\nSource:\n${CMAKE_CONFIGURABLE_FILE_CONTENT}\n")
  122. endif()
  123. endif()
  124. endmacro()