cmake/Modules/CheckOBJCXXSourceRuns.cmake

57 lines
2.0 KiB
CMake
Raw Normal View History

2020-02-01 23:06:01 +01:00
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
CheckOBJCXXSourceRuns
---------------------
2021-09-14 00:13:48 +02:00
.. versionadded:: 3.16
2020-02-01 23:06:01 +01:00
Check if given Objective-C++ source compiles and links into an executable and can
subsequently be run.
.. command:: check_objcxx_source_runs
.. code-block:: cmake
check_objcxx_source_runs(<code> <resultVar>)
Check that the source supplied in ``<code>`` can be compiled as a Objective-C++ source
file, linked as an executable and then run. The ``<code>`` must contain at
least a ``main()`` function. If the ``<code>`` could be built and run
successfully, the internal cache variable specified by ``<resultVar>`` will
be set to 1, otherwise it will be set to an value that evaluates to boolean
false (e.g. an empty string or an error message).
2023-07-02 19:51:09 +02:00
The check is only performed once, with the result cached in the variable named
by ``<resultVar>``. Every subsequent CMake run will re-use this cached value
rather than performing the check again, even if the ``<code>`` changes. In
order to force the check to be re-evaluated, the variable named by
2020-02-01 23:06:01 +01:00
``<resultVar>`` must be manually removed from the cache.
2023-07-02 19:51:09 +02:00
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_objcxx_source_runs()``
.. include:: /module/CMAKE_REQUIRED_FLAGS.txt
.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
.. include:: /module/CMAKE_REQUIRED_QUIET.txt
2020-02-01 23:06:01 +01:00
#]=======================================================================]
include_guard(GLOBAL)
2021-09-14 00:13:48 +02:00
include(Internal/CheckSourceRuns)
2020-02-01 23:06:01 +01:00
macro(CHECK_OBJCXX_SOURCE_RUNS SOURCE VAR)
2021-09-14 00:13:48 +02:00
set(_CheckSourceRuns_old_signature 1)
cmake_check_source_runs(OBJCXX "${SOURCE}" ${VAR} ${ARGN})
unset(_CheckSourceRuns_old_signature)
2020-02-01 23:06:01 +01:00
endmacro()