Modules/CheckCSourceCompiles.cmake

   1 # Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   2 # file Copyright.txt or https://cmake.org/licensing for details.
   3
   4 #[=======================================================================[.rst:
   5 CheckCSourceCompiles
   6 --------------------
   7
   8 Check once if C source code can be built.
   9
  10 .. command:: check_c_source_compiles
  11
  12   .. code-block:: cmake
  13
  14     check_c_source_compiles(<code> <resultVar>
  15                             [FAIL_REGEX <regex1> [<regex2>...]])
  16
  17   Check once that the source supplied in ``<code>`` can be built. The result is
  18   stored in the internal cache variable specified by ``<resultVar>``, with
  19   boolean ``true`` for success and boolean ``false`` for failure.
  20
  21   If ``FAIL_REGEX`` is provided, then failure is determined by checking
  22   if anything in the compiler output matches any of the specified regular
  23   expressions.
  24
  25   Internally, :command:`try_compile` is used to compile the source. If
  26   :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is set to ``EXECUTABLE`` (default),
  27   the source is compiled and linked as an executable program. If set to
  28   ``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
  29   functions must be declared as usual.
  30
  31   See also :command:`check_source_compiles` for a more general command syntax.
  32
  33   See also :command:`check_source_runs` to run compiled source.
  34
  35   The compile and link commands can be influenced by setting any of the
  36   following variables prior to calling ``check_c_source_compiles()``:
  37
  38 .. include:: /module/CMAKE_REQUIRED_FLAGS.txt
  39
  40 .. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
  41
  42 .. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
  43
  44 .. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
  45
  46 .. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
  47
  48 .. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt
  49
  50 .. include:: /module/CMAKE_REQUIRED_QUIET.txt
  51
  52 #]=======================================================================]
  53
  54 include_guard(GLOBAL)
  55 include(Internal/CheckSourceCompiles)
  56
  57 macro(CHECK_C_SOURCE_COMPILES SOURCE VAR)
  58   cmake_check_source_compiles(C "${SOURCE}" ${VAR} ${ARGN})
  59 endmacro()