summaryrefslogtreecommitdiff
path: root/Modules/CheckCXXSymbolExists.cmake
blob: d067001b4d9981bd9c96f2ef7c39605f4a81dab9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.

#[=======================================================================[.rst:
CheckCXXSymbolExists
--------------------

Check if a symbol exists as a function, variable, or macro in C++

.. code-block:: cmake

  CHECK_CXX_SYMBOL_EXISTS(<symbol> <files> <variable>)

Check that the ``<symbol>`` is available after including given header
``<files>`` and store the result in a ``<variable>``.  Specify the list of
files in one argument as a semicolon-separated list.
CHECK_CXX_SYMBOL_EXISTS() can be used to check in C++ files, as
opposed to CHECK_SYMBOL_EXISTS(), which works only for C.

If the header files define the symbol as a macro it is considered
available and assumed to work.  If the header files declare the symbol
as a function or variable then the symbol must also be available for
linking.  If the symbol is a type or enum value it will not be
recognized (consider using CheckTypeSize or CheckCSourceCompiles).

The following variables may be set before calling this macro to modify
the way the check is run:

``CMAKE_REQUIRED_FLAGS``
   string of compile command line flags
``CMAKE_REQUIRED_DEFINITIONS``
   list of macros to define (-DFOO=bar)
``CMAKE_REQUIRED_INCLUDES``
   list of include directories
``CMAKE_REQUIRED_LIBRARIES``
   list of libraries to link
``CMAKE_REQUIRED_QUIET``
   execute quietly without messages
#]=======================================================================]

include_guard(GLOBAL)
include(CheckSymbolExists)

macro(CHECK_CXX_SYMBOL_EXISTS SYMBOL FILES VARIABLE)
  __CHECK_SYMBOL_EXISTS_IMPL("${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/CheckSymbolExists.cxx" "${SYMBOL}" "${FILES}" "${VARIABLE}" )
endmacro()