CheckSourceCompiles¶
Added in version 3.19.
Check if given source compiles and links into an executable.
- check_source_compiles¶
check_source_compiles(<lang> <code> <resultVar> [FAIL_REGEX <regex1> [<regex2>...]] [SRC_EXT <extension>])
Check that the source supplied in
<code>can be compiled as a source file for the requested language and linked as an executable. The result will be stored in the internal cache variable specified by<resultVar>, with a boolean true value for success and boolean false for failure. IfFAIL_REGEXis provided, then failure is determined by checking if anything in the compiler output matches any of the specified regular expressions.By default, the test source file will be given a file extension that matches the requested language. The
SRC_EXToption can be used to override this with.<extension>instead.The
<code>must contain a valid main program. For example:check_source_compiles(C "#include <stdlib.h> #include <stdnoreturn.h> noreturn void f(){ exit(0); } int main(void) { f(); return 1; }" HAVE_NORETURN) check_source_compiles(Fortran "program test error stop end program" HAVE_ERROR_STOP)
The check is only performed once, with the result cached in the variable named by
<resultVar>. Every subsequent CMake run will reuse 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<resultVar>must be manually removed from the cache.The compile and link commands can be influenced by setting any of the following variables prior to calling
check_source_compiles():
CMAKE_REQUIRED_FLAGSString of additional flags to pass to the compiler. The string must be space-delimited--a ;-list will not work. The contents of
CMAKE_<LANG>_FLAGSand its associated configuration-specific variable are automatically added to the compiler command before the contents ofCMAKE_REQUIRED_FLAGS.
CMAKE_REQUIRED_DEFINITIONSA ;-list of compiler definitions of the form
-DFOOor-DFOO=bar. A definition for the name specified by<resultVar>will also be added automatically.
CMAKE_REQUIRED_INCLUDESA ;-list of header search paths to pass to the compiler. These will be the only header search paths used--the contents of the
INCLUDE_DIRECTORIESdirectory property will be ignored.
CMAKE_REQUIRED_LINK_OPTIONSAdded in version 3.14.
A ;-list of options to add to the link command (see
try_compile()for further details).
CMAKE_REQUIRED_LIBRARIESA ;-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_compile()for further details).
CMAKE_REQUIRED_QUIETAdded in version 3.1.
If this variable evaluates to a boolean true value, all status messages associated with the check will be suppressed.