mirror of
https://github.com/Kitware/CMake.git
synced 2025-12-30 18:29:37 -06:00
5d42177a06
The CheckSourceCompiles and CheckCompilerFlag would generally be preferred general command syntax, but users may not realize they exist, so help point them there.
58 lines
2.0 KiB
CMake
58 lines
2.0 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file Copyright.txt or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
CheckCXXSourceCompiles
|
|
----------------------
|
|
|
|
Check once if C++ source code can be built.
|
|
|
|
.. command:: check_cxx_source_compiles
|
|
|
|
.. code-block:: cmake
|
|
|
|
check_cxx_source_compiles(<code> <resultVar>
|
|
[FAIL_REGEX <regex1> [<regex2>...]])
|
|
|
|
Check once that the source supplied in ``<code>`` can be built. The result is
|
|
stored in the internal cache variable specified by ``<resultVar>``, with
|
|
boolean ``true`` for success and boolean ``false`` for failure.
|
|
|
|
If ``FAIL_REGEX`` is provided, then failure is determined by checking
|
|
if anything in the compiler output matches any of the specified regular
|
|
expressions.
|
|
|
|
Internally, :command:`try_compile` is used to compile the source. If
|
|
:variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is set to ``EXECUTABLE`` (default),
|
|
the source is compiled and linked as an executable program. If set to
|
|
``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
|
|
functions must be declared as usual.
|
|
|
|
See also :command:`check_source_compiles` for a more general command syntax.
|
|
|
|
See also :command:`check_source_runs` to run compiled source.
|
|
|
|
The compile and link commands can be influenced by setting any of the
|
|
following variables prior to calling ``check_cxx_source_compiles()``:
|
|
|
|
.. 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
|
|
|
|
#]=======================================================================]
|
|
|
|
include_guard(GLOBAL)
|
|
include(Internal/CheckSourceCompiles)
|
|
|
|
macro(CHECK_CXX_SOURCE_COMPILES SOURCE VAR)
|
|
cmake_check_source_compiles(CXX "${SOURCE}" ${VAR} ${ARGN})
|
|
endmacro()
|