CheckSymbolExists.cmake 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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. ::
  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. list of macros to define (-DFOO=bar)
  29. ``CMAKE_REQUIRED_INCLUDES``
  30. list of include directories
  31. ``CMAKE_REQUIRED_LIBRARIES``
  32. list of libraries to link
  33. ``CMAKE_REQUIRED_QUIET``
  34. execute quietly without messages
  35. #]=======================================================================]
  36. include_guard(GLOBAL)
  37. macro(CHECK_SYMBOL_EXISTS SYMBOL FILES VARIABLE)
  38. if(CMAKE_C_COMPILER_LOADED)
  39. __CHECK_SYMBOL_EXISTS_IMPL("${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/CheckSymbolExists.c" "${SYMBOL}" "${FILES}" "${VARIABLE}" )
  40. elseif(CMAKE_CXX_COMPILER_LOADED)
  41. __CHECK_SYMBOL_EXISTS_IMPL("${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/CheckSymbolExists.cxx" "${SYMBOL}" "${FILES}" "${VARIABLE}" )
  42. else()
  43. message(FATAL_ERROR "CHECK_SYMBOL_EXISTS needs either C or CXX language enabled")
  44. endif()
  45. endmacro()
  46. macro(__CHECK_SYMBOL_EXISTS_IMPL SOURCEFILE SYMBOL FILES VARIABLE)
  47. if(NOT DEFINED "${VARIABLE}" OR "x${${VARIABLE}}" STREQUAL "x${VARIABLE}")
  48. set(CMAKE_CONFIGURABLE_FILE_CONTENT "/* */\n")
  49. set(MACRO_CHECK_SYMBOL_EXISTS_FLAGS ${CMAKE_REQUIRED_FLAGS})
  50. if(CMAKE_REQUIRED_LIBRARIES)
  51. set(CHECK_SYMBOL_EXISTS_LIBS
  52. LINK_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES})
  53. else()
  54. set(CHECK_SYMBOL_EXISTS_LIBS)
  55. endif()
  56. if(CMAKE_REQUIRED_INCLUDES)
  57. set(CMAKE_SYMBOL_EXISTS_INCLUDES
  58. "-DINCLUDE_DIRECTORIES:STRING=${CMAKE_REQUIRED_INCLUDES}")
  59. else()
  60. set(CMAKE_SYMBOL_EXISTS_INCLUDES)
  61. endif()
  62. foreach(FILE ${FILES})
  63. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT
  64. "#include <${FILE}>\n")
  65. endforeach()
  66. string(APPEND CMAKE_CONFIGURABLE_FILE_CONTENT
  67. "\nint main(int argc, char** argv)\n{\n (void)argv;\n#ifndef ${SYMBOL}\n return ((int*)(&${SYMBOL}))[argc];\n#else\n (void)argc;\n return 0;\n#endif\n}\n")
  68. configure_file("${CMAKE_ROOT}/Modules/CMakeConfigurableFile.in"
  69. "${SOURCEFILE}" @ONLY)
  70. if(NOT CMAKE_REQUIRED_QUIET)
  71. message(STATUS "Looking for ${SYMBOL}")
  72. endif()
  73. try_compile(${VARIABLE}
  74. ${CMAKE_BINARY_DIR}
  75. "${SOURCEFILE}"
  76. COMPILE_DEFINITIONS ${CMAKE_REQUIRED_DEFINITIONS}
  77. ${CHECK_SYMBOL_EXISTS_LIBS}
  78. CMAKE_FLAGS
  79. -DCOMPILE_DEFINITIONS:STRING=${MACRO_CHECK_SYMBOL_EXISTS_FLAGS}
  80. "${CMAKE_SYMBOL_EXISTS_INCLUDES}"
  81. OUTPUT_VARIABLE OUTPUT)
  82. if(${VARIABLE})
  83. if(NOT CMAKE_REQUIRED_QUIET)
  84. message(STATUS "Looking for ${SYMBOL} - found")
  85. endif()
  86. set(${VARIABLE} 1 CACHE INTERNAL "Have symbol ${SYMBOL}")
  87. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
  88. "Determining if the ${SYMBOL} "
  89. "exist passed with the following output:\n"
  90. "${OUTPUT}\nFile ${SOURCEFILE}:\n"
  91. "${CMAKE_CONFIGURABLE_FILE_CONTENT}\n")
  92. else()
  93. if(NOT CMAKE_REQUIRED_QUIET)
  94. message(STATUS "Looking for ${SYMBOL} - not found")
  95. endif()
  96. set(${VARIABLE} "" CACHE INTERNAL "Have symbol ${SYMBOL}")
  97. file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
  98. "Determining if the ${SYMBOL} "
  99. "exist failed with the following output:\n"
  100. "${OUTPUT}\nFile ${SOURCEFILE}:\n"
  101. "${CMAKE_CONFIGURABLE_FILE_CONTENT}\n")
  102. endif()
  103. endif()
  104. endmacro()