CheckFortranSourceRuns — CMake 4.3.3 Documentation

# CheckFortranSourceRuns

Added in version 3.14.

This module provides a command to check whether a Fortran source can be built and run.

Load this module in a CMake project with:

    include(CheckFortranSourceRuns)

## Commands

This module provides the following command:

check_fortran_source_runs

  Checks once whether the given Fortran source compiles and links into an executable that can subsequently be run.

      check_fortran_source_runs(<code> <variable> [SRC_EXT <extension>])

  The Fortran source supplied in `<code>` must contain a Fortran `program` unit. 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.

  The options are:

  `SRC_EXT <extension>`

    By default, the internal test source file used for the check will be given a `.F90` file extension. This option can be used to change the extension to `.<extension>` instead.

  Variables Affecting the Check

  The following variables may be set before calling this command to modify the way the check is run:

  `CMAKE_REQUIRED_FLAGS`

    A space-separated string of additional flags to pass to the compiler. A semicolon-separated list will not work. The contents of `CMAKE_<LANG>_FLAGS` and its associated configuration-specific `CMAKE_<LANG>_FLAGS_<CONFIG>` variables are automatically prepended to the compiler command before the contents of this variable.

  `CMAKE_REQUIRED_DEFINITIONS`

    A semicolon-separated list of compiler definitions, each of the form `-DFOO` or `-DFOO=bar`. A definition for the name specified by the result variable argument of the check command is also added automatically.

  `CMAKE_REQUIRED_INCLUDES`

    A semicolon-separated 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 semicolon-separated list of options to add to the link command (see `try_compile()` for further details).

  `CMAKE_REQUIRED_LIBRARIES`

    A semicolon-separated list of libraries to add to the link command. These can be the names 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 semicolon-separated list of library 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.

## Examples

The following example shows how to use this module to check whether a Fortran source code runs and store the result of the check in an internal cache variable `HAVE_COARRAY`:

    include(CheckFortranSourceRuns)

    check_fortran_source_runs([[
      program test
      real :: x[*]
      call co_sum(x)
      end program
    ]] HAVE_COARRAY)

## See Also

- The `CheckSourceRuns` module for a more general command syntax.

- The `CheckSourceCompiles` module to check whether a source code can be built.