CheckSymbolExists.cmake 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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. CheckSymbolExists
  5. -----------------
  6. Provides a macro to check if a symbol exists as a function, variable,
  7. or macro in ``C``.
  8. .. command:: check_symbol_exists
  9. .. code-block:: cmake
  10. check_symbol_exists(<symbol> <files> <variable>)
  11. Check that the ``<symbol>`` is available after including given header
  12. ``<files>`` and store the result in a ``<variable>``. Specify the list
  13. of files in one argument as a semicolon-separated list.
  14. ``<variable>`` will be created as an internal cache variable.
  15. If the header files define the symbol as a macro it is considered
  16. available and assumed to work. If the header files declare the symbol
  17. as a function or variable then the symbol must also be available for
  18. linking (so intrinsics may not be detected).
  19. If the symbol is a type, enum value, or intrinsic it will not be recognized
  20. (consider using :module:`CheckTypeSize` or :module:`CheckCSourceCompiles`).
  21. If the check needs to be done in C++, consider using
  22. :module:`CheckCXXSymbolExists` instead.
  23. The following variables may be set before calling this macro to modify
  24. the way the check is run:
  25. ``CMAKE_REQUIRED_FLAGS``
  26. string of compile command line flags.
  27. ``CMAKE_REQUIRED_DEFINITIONS``
  28. a :ref:`;-list <CMake Language Lists>` of macros to define (-DFOO=bar).
  29. ``CMAKE_REQUIRED_INCLUDES``
  30. a :ref:`;-list <CMake Language Lists>` of header search paths to pass to
  31. the compiler.
  32. ``CMAKE_REQUIRED_LINK_OPTIONS``
  33. a :ref:`;-list <CMake Language Lists>` of options to add to the link command.
  34. ``CMAKE_REQUIRED_LIBRARIES``
  35. a :ref:`;-list <CMake Language Lists>` of libraries to add to the link
  36. command. See policy :policy:`CMP0075`.
  37. ``CMAKE_REQUIRED_QUIET``
  38. execute quietly without messages.
  39. For example:
  40. .. code-block:: cmake
  41. include(CheckSymbolExists)
  42. # Check for macro SEEK_SET
  43. check_symbol_exists(SEEK_SET "stdio.h" HAVE_SEEK_SET)
  44. # Check for function fopen
  45. check_symbol_exists(fopen "stdio.h" HAVE_FOPEN)
  46. #]=======================================================================]
  47. include_guard(GLOBAL)
  48. cmake_policy(PUSH)
  49. cmake_policy(SET CMP0054 NEW) # if() quoted variables not dereferenced
  50. macro(CHECK_SYMBOL_EXISTS SYMBOL FILES VARIABLE)
  51. if(CMAKE_C_COMPILER_LOADED)
  52. __CHECK_SYMBOL_EXISTS_IMPL("${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/CheckSymbolExists.c" "${SYMBOL}" "${FILES}" "${VARIABLE}" )
  53. elseif(CMAKE_CXX_COMPILER_LOADED)
  54. __CHECK_SYMBOL_EXISTS_IMPL("${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/CheckSymbolExists.cxx" "${SYMBOL}" "${FILES}" "${VARIABLE}" )
  55. else()
  56. message(FATAL_ERROR "CHECK_SYMBOL_EXISTS needs either C or CXX language enabled")
  57. endif()
  58. endmacro()
  59. macro(__CHECK_SYMBOL_EXISTS_IMPL SOURCEFILE SYMBOL FILES VARIABLE)
  60. if(NOT DEFINED "${VARIABLE}" OR "x${${VARIABLE}}" STREQUAL "x${VARIABLE}")
  61. set(CMAKE_CONFIGURABLE_FILE_CONTENT "/* */\n")
  62. set(MACRO_CHECK_SYMBOL_EXISTS_FLAGS ${CMAKE_REQUIRED_FLAGS})
  63. if(CMAKE_REQUIRED_LINK_OPTIONS)
  64. set(CHECK_SYMBOL_EXISTS_LINK_OPTIONS
  65. LINK_OPTIONS ${CMAKE_REQUIRED_LINK_OPTIONS})
  66. else()
  67. set(CHECK_SYMBOL_EXISTS_LINK_OPTIONS)
  68. endif()
  69. if(CMAKE_REQUIRED_LIBRARIES)
  70. set(CHECK_SYMBOL_EXISTS_LIBS
  71. LINK_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES})
  72. else()
  73. set(CHECK_SYMBOL_EXISTS_LIBS)
  74. endif()
  75. if(CMAKE_REQUIRED_INCLUDES)
  76. set(CMAKE_SYMBOL_EXISTS_INCLUDES
  77. "-DINCLUDE_DIRECTORIES:STRING=${CMAKE_REQUIRED_INCLUDES}")
  78. else()
  79. set(CMAKE_SYMBOL_EXISTS_INCLUDES)
  80. endif()
  81. foreach(FILE ${FILES})
  82. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT
  83. "#include <${FILE}>\n")
  84. endforeach()
  85. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT "
  86. int main(int argc, char** argv)
  87. {
  88. (void)argv;")
  89. set(_CSE_CHECK_NON_MACRO "return ((int*)(&${SYMBOL}))[argc];")
  90. if("${SYMBOL}" MATCHES "^[a-zA-Z_][a-zA-Z0-9_]*$")
  91. # The SYMBOL has a legal macro name. Test whether it exists as a macro.
  92. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT "
  93. #ifndef ${SYMBOL}
  94. ${_CSE_CHECK_NON_MACRO}
  95. #else
  96. (void)argc;
  97. return 0;
  98. #endif")
  99. else()
  100. # The SYMBOL cannot be a macro (e.g., a template function).
  101. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT "
  102. ${_CSE_CHECK_NON_MACRO}")
  103. endif()
  104. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT "
  105. }")
  106. unset(_CSE_CHECK_NON_MACRO)
  107. configure_file("${CMAKE_ROOT}/Modules/CMakeConfigurableFile.in"
  108. "${SOURCEFILE}" @ONLY)
  109. if(NOT CMAKE_REQUIRED_QUIET)
  110. message(STATUS "Looking for ${SYMBOL}")
  111. endif()
  112. try_compile(${VARIABLE}
  113. ${CMAKE_BINARY_DIR}
  114. "${SOURCEFILE}"
  115. COMPILE_DEFINITIONS ${CMAKE_REQUIRED_DEFINITIONS}
  116. ${CHECK_SYMBOL_EXISTS_LINK_OPTIONS}
  117. ${CHECK_SYMBOL_EXISTS_LIBS}
  118. CMAKE_FLAGS
  119. -DCOMPILE_DEFINITIONS:STRING=${MACRO_CHECK_SYMBOL_EXISTS_FLAGS}
  120. "${CMAKE_SYMBOL_EXISTS_INCLUDES}"
  121. OUTPUT_VARIABLE OUTPUT)
  122. if(${VARIABLE})
  123. if(NOT CMAKE_REQUIRED_QUIET)
  124. message(STATUS "Looking for ${SYMBOL} - found")
  125. endif()
  126. set(${VARIABLE} 1 CACHE INTERNAL "Have symbol ${SYMBOL}")
  127. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
  128. "Determining if the ${SYMBOL} "
  129. "exist passed with the following output:\n"
  130. "${OUTPUT}\nFile ${SOURCEFILE}:\n"
  131. "${CMAKE_CONFIGURABLE_FILE_CONTENT}\n")
  132. else()
  133. if(NOT CMAKE_REQUIRED_QUIET)
  134. message(STATUS "Looking for ${SYMBOL} - not found")
  135. endif()
  136. set(${VARIABLE} "" CACHE INTERNAL "Have symbol ${SYMBOL}")
  137. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
  138. "Determining if the ${SYMBOL} "
  139. "exist failed with the following output:\n"
  140. "${OUTPUT}\nFile ${SOURCEFILE}:\n"
  141. "${CMAKE_CONFIGURABLE_FILE_CONTENT}\n")
  142. endif()
  143. unset(CMAKE_CONFIGURABLE_FILE_CONTENT)
  144. endif()
  145. endmacro()
  146. cmake_policy(POP)