CheckOBJCSourceRuns — CMake 4.0.3-dirty Documentation

# CheckOBJCSourceRuns

Added in version 3.16.

Check once if given Objective-C source compiles and links into an executable and can subsequently be run.

check_objc_source_runs

      check_objc_source_runs(<code> <resultVar>)

  Check once that the source supplied in `<code>` can be built, linked as an executable, and then run. The `<code>` must contain at least a `main()` function.

  The result is stored in the internal cache variable specified by `<resultVar>`. If the code builds and runs with exit code `0`, success is indicated by boolean `true`. Failure to build or run is indicated by boolean `false`, such as an empty string or an error message.

  See also `check_source_runs()` for a more general command syntax.

  The compile and link commands can be influenced by setting any of the following variables prior to calling `check_objc_source_runs()`

> `CMAKE_REQUIRED_FLAGS`

>   String of additional flags to pass to the compiler. The string must be space-delimited--a ;-list will not work. The contents of `CMAKE_<LANG>_FLAGS` and its associated configuration-specific variable are automatically added to the compiler command before the contents of `CMAKE_REQUIRED_FLAGS`.

> `CMAKE_REQUIRED_DEFINITIONS`

>   A ;-list of compiler definitions of the form `-DFOO` or `-DFOO=bar`. A definition for the name specified by `<resultVar>` will 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--the contents of the `INCLUDE_DIRECTORIES` directory property will be ignored.

> `CMAKE_REQUIRED_LINK_OPTIONS`

>   Added in version 3.14.

>   A ;-list of options to add to the link command (see `try_compile()` for further details).

> `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_compile()` for further details).

> `CMAKE_REQUIRED_LINK_DIRECTORIES`

>   Added in version 3.31.

>   A ;-list of libraries search paths to pass to the linker (see `try_compile()` for further details).

> `CMAKE_REQUIRED_QUIET`

>   Added in version 3.1.

>   If this variable evaluates to a boolean true value, all status messages associated with the check will be suppressed.