mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-01 03:11:08 -06:00
c5980ad868
This updates the following modules: - CheckCSourceRuns - CheckCXXSourceRuns - CheckFortranSourceRuns - CheckOBJCSourceRuns - CheckOBJCXXSourceRuns - CheckSourceRuns Changes: - Added intro code blocks showing how to include these modules. - Used word "command" instead of "macro". - Added "Commands" sections to have a clearer overview of the modules at first encounter. - Reworded commands descriptions and arguments a bit. - Added a rubric title for variables that affect the checks. - Added "Examples" sections. - Added "See Also" sections. - Added few more examples in the CheckSourceRuns module to show how to use this module with different languages, `CMAKE_REQUIRED_*` variables, and mentioned bracket argument syntax a bit.
100 lines
2.9 KiB
CMake
100 lines
2.9 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file LICENSE.rst or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
CheckCXXSourceRuns
|
|
------------------
|
|
|
|
This module provides a command to check whether a C++ source can be built
|
|
and run.
|
|
|
|
Load this module in a CMake project with:
|
|
|
|
.. code-block:: cmake
|
|
|
|
include(CheckCXXSourceRuns)
|
|
|
|
Commands
|
|
^^^^^^^^
|
|
|
|
This module provides the following command:
|
|
|
|
.. command:: check_cxx_source_runs
|
|
|
|
Checks once whether the given C++ source code compiles and links into an
|
|
executable that can subsequently be run:
|
|
|
|
.. code-block:: cmake
|
|
|
|
check_cxx_source_runs(<code> <variable>)
|
|
|
|
The C++ source supplied in ``<code>`` must contain at least a ``main()``
|
|
function. The result of the check is stored in the internal cache variable
|
|
specified by ``<variable>``. If the code builds and runs with exit code
|
|
``0``, success is indicated by a boolean true value. Failure to build or
|
|
run is indicated by a boolean false value, such as an empty string or an
|
|
error message.
|
|
|
|
.. rubric:: Variables Affecting the Check
|
|
|
|
The following variables may be set before calling this command to modify
|
|
the way the check is run:
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst
|
|
|
|
Examples
|
|
^^^^^^^^
|
|
|
|
The following example demonstrates how to check whether the C++ standard
|
|
library is functional and ``std::vector`` works at runtime. If the source
|
|
compiles, links, and runs successfully, internal cache variable
|
|
``HAVE_WORKING_STD_VECTOR`` will be set to boolean true value. Code is
|
|
supplied using :ref:`Bracket Argument` for easier embedded quotes handling:
|
|
|
|
.. code-block:: cmake
|
|
:force:
|
|
|
|
include(CheckCXXSourceRuns)
|
|
|
|
check_cxx_source_runs([[
|
|
#include <iostream>
|
|
#include <vector>
|
|
|
|
int main()
|
|
{
|
|
std::vector<int> v = {1, 2, 3};
|
|
if (v.size() != 3) return 1;
|
|
std::cout << "Vector works correctly." << std::endl;
|
|
return 0;
|
|
}
|
|
]] HAVE_WORKING_STD_VECTOR)
|
|
|
|
See Also
|
|
^^^^^^^^
|
|
|
|
* The :module:`CheckSourceRuns` module for a more general command syntax.
|
|
* The :module:`CheckSourceCompiles` module to check whether a source code
|
|
can be built.
|
|
#]=======================================================================]
|
|
|
|
include_guard(GLOBAL)
|
|
include(Internal/CheckSourceRuns)
|
|
|
|
macro(CHECK_CXX_SOURCE_RUNS SOURCE VAR)
|
|
set(_CheckSourceRuns_old_signature 1)
|
|
cmake_check_source_runs(CXX "${SOURCE}" ${VAR} ${ARGN})
|
|
unset(_CheckSourceRuns_old_signature)
|
|
endmacro()
|