Modules/CheckCSourceRuns.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 CheckCSourceRuns
   6 ----------------
   7
   8 Check if given C source compiles and links into an executable and can
   9 subsequently be run.
  10
  11 .. command:: check_c_source_runs
  12
  13   .. code-block:: cmake
  14
  15     check_c_source_runs(<code> <resultVar>)
  16
  17   Check that the source supplied in ``<code>`` can be compiled as a C source
  18   file, linked as an executable and then run. The ``<code>`` must contain at
  19   least a ``main()`` function. If the ``<code>`` could be built and run
  20   successfully, the internal cache variable specified by ``<resultVar>`` will
  21   be set to 1, otherwise it will be set to an value that evaluates to boolean
  22   false (e.g. an empty string or an error message).
  23
  24   The check is only performed once, with the result cached in the variable named
  25   by ``<resultVar>``. Every subsequent CMake run will reuse this cached value
  26   rather than performing the check again, even if the ``<code>`` changes. In
  27   order to force the check to be re-evaluated, the variable named by
  28   ``<resultVar>`` must be manually removed from the cache.
  29
  30   The compile and link commands can be influenced by setting any of the
  31   following variables prior to calling ``check_c_source_runs()``:
  32
  33 .. include:: /module/CMAKE_REQUIRED_FLAGS.txt
  34
  35 .. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
  36
  37 .. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
  38
  39 .. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
  40
  41 .. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
  42
  43 .. include:: /module/CMAKE_REQUIRED_QUIET.txt
  44
  45 #]=======================================================================]
  46
  47 include_guard(GLOBAL)
  48 include(Internal/CheckSourceRuns)
  49
  50 macro(CHECK_C_SOURCE_RUNS SOURCE VAR)
  51   set(_CheckSourceRuns_old_signature 1)
  52   cmake_check_source_runs(C "${SOURCE}" ${VAR} ${ARGN})
  53   unset(_CheckSourceRuns_old_signature)
  54 endmacro()