CheckCXXSourceRuns¶
Check if given C++ source compiles and links into an executable and can subsequently be run.
-
check_cxx_source_runs¶ check_cxx_source_runs(code resultVar)
Check that the source supplied in
codecan be compiled as a C++ source file, linked as an executable and then run. Thecodemust contain at least amain()function. If the code could be built and run successfully, the internal cache variable specified byresultVarwill 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).The underlying check is performed by the
try_run()command. The compile and link commands can be influenced by setting any of the following variables prior to callingcheck_cxx_source_runs():CMAKE_REQUIRED_FLAGS- Additional flags to pass to the compiler. Note that the contents of
CMAKE_CXX_FLAGSand its associated configuration-specific variable are automatically added to the compiler command before the contents ofCMAKE_REQUIRED_FLAGS. CMAKE_REQUIRED_DEFINITIONS- A ;-list of compiler definitions of the form
-DFOOor-DFOO=bar. A definition for the name specified byresultVarwill also be added automatically. CMAKE_REQUIRED_INCLUDES- A ;-list of header search paths to pass to
the compiler. These will be the only header search paths used by
try_run(), i.e. the contents of theINCLUDE_DIRECTORIESdirectory property will be ignored. CMAKE_REQUIRED_LIBRARIES- A ;-list of libraries to add to the link
command. These can be the name of system libraries or they can be
Imported Targets (see
try_run()for further details). CMAKE_REQUIRED_QUIET- If this variable evaluates to a boolean true value, all status messages associated with the check will be suppressed.
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 thecodechanges. In order to force the check to be re-evaluated, the variable named byresultVarmust be manually removed from the cache.