Try compiling and then running some code.
try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR bindir srcfile [CMAKE_FLAGS <flags>...] [COMPILE_DEFINITIONS <defs>...] [LINK_LIBRARIES <libs>...] [COMPILE_OUTPUT_VARIABLE <var>] [RUN_OUTPUT_VARIABLE <var>] [OUTPUT_VARIABLE <var>] [ARGS <args>...])
Try compiling a <srcfile>
. Returns TRUE
or FALSE
for success or failure in COMPILE_RESULT_VAR
. If the compile succeeded, runs the executable and returns its exit code in RUN_RESULT_VAR
. If the executable was built, but failed to run, then RUN_RESULT_VAR
will be set to FAILED_TO_RUN
. See the try_compile()
command for information on how the test project is constructed to build the source file.
The options are:
CMAKE_FLAGS <flags>...
-DVAR:TYPE=VALUE
to be passed to the cmake
command-line used to drive the test build. The example in try_compile()
shows how values for variables INCLUDE_DIRECTORIES
, LINK_DIRECTORIES
, and LINK_LIBRARIES
are used.COMPILE_DEFINITIONS <defs>...
-Ddefinition
arguments to pass to add_definitions
in the generated test project.COMPILE_OUTPUT_VARIABLE <var>
LINK_LIBRARIES <libs>...
Specify libraries to be linked in the generated project. The list of libraries may refer to system libraries and to Imported Targets from the calling project.
If this option is specified, any -DLINK_LIBRARIES=...
value given to the CMAKE_FLAGS
option will be ignored.
OUTPUT_VARIABLE <var>
COMPILE_OUTPUT_VARIABLE
and RUN_OUTPUT_VARIABLE
instead.RUN_OUTPUT_VARIABLE <var>
Set the CMAKE_TRY_COMPILE_CONFIGURATION
variable to choose a build configuration.
When cross compiling, the executable compiled in the first step usually cannot be run on the build host. The try_run
command checks the CMAKE_CROSSCOMPILING
variable to detect whether CMake is in cross-compiling mode. If that is the case, it will still try to compile the executable, but it will not try to run the executable unless the CMAKE_CROSSCOMPILING_EMULATOR
variable is set. Instead it will create cache variables which must be filled by the user or by presetting them in some CMake script file to the values the executable would have produced if it had been run on its actual target platform. These cache entries are:
<RUN_RESULT_VAR>
<RUN_RESULT_VAR>__TRYRUN_OUTPUT
RUN_OUTPUT_VARIABLE
or OUTPUT_VARIABLE
option was used.In order to make cross compiling your project easier, use try_run
only if really required. If you use try_run
, use the RUN_OUTPUT_VARIABLE
or OUTPUT_VARIABLE
options only if really required. Using them will require that when cross-compiling, the cache variables will have to be set manually to the output of the executable. You can also “guard” the calls to try_run
with an if()
block checking the CMAKE_CROSSCOMPILING
variable and provide an easy-to-preset alternative for this case.
© 2000–2016 Kitware, Inc.
© 2000–2011 Insight Software Consortium
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.5/command/try_run.html