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