mirror of
https://github.com/Kitware/CMake.git
synced 2025-12-30 02:10:10 -06:00
ac67631b02
- Added intro code blocks showing how to include these modules.
- Used word "command" instead of "macro".
- Added examples sections.
- Updated and synced descriptions of commands and arguments.
- Added a rubric title for variables that affect the checks.
- Listed CMAKE_TRY_COMPILE_TARGET_TYPE variable in the rubric together
with CMAKE_REQUIRED_* variables.
- Added link to CheckCompilerFlag module in the target_compile_options()
docs.
- Used lowercase style for check_fortran_compiler_flag() command.
- Added a link to `$<COMPILE_LANGUAGE:languages>` generator expression
so it can be linked from other pages (See commit
2e37a20f02 for more info on the initial
style used).
- Fixed the GENEX_NOTE inclusion (starting with line after the 2nd line)
where part of the sentence was rendered in the output.
126 lines
3.8 KiB
CMake
126 lines
3.8 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file LICENSE.rst or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
CheckCompilerFlag
|
|
---------------------
|
|
|
|
.. versionadded:: 3.19
|
|
|
|
This module provides a command to check whether the compiler supports a given
|
|
flag.
|
|
|
|
Load this module in a CMake project with:
|
|
|
|
.. code-block:: cmake
|
|
|
|
include(CheckCompilerFlag)
|
|
|
|
Commands
|
|
^^^^^^^^
|
|
|
|
This module provides the following command:
|
|
|
|
.. command:: check_compiler_flag
|
|
|
|
Checks once whether the compiler supports a given flag:
|
|
|
|
.. code-block:: cmake
|
|
|
|
check_compiler_flag(<lang> <flag> <variable>)
|
|
|
|
This command checks once that the ``<flag>`` is accepted by the ``<lang>``
|
|
compiler without producing a diagnostic message. The result of the check
|
|
is stored in the internal cache variable specified by ``<variable>``.
|
|
|
|
The arguments are:
|
|
|
|
``<lang>``
|
|
The language of the compiler used for the check. Supported languages
|
|
are: ``C``, ``CXX``, ``CUDA``, ``Fortran``, ``HIP``, ``ISPC``, ``OBJC``,
|
|
and ``OBJCXX``, and ``Swift``.
|
|
|
|
.. versionadded:: 3.21
|
|
Support for ``HIP`` language.
|
|
|
|
.. versionadded:: 3.26
|
|
Support for ``Swift`` language.
|
|
|
|
``<flag>``
|
|
Compiler flag(s) to check. Multiple flags can be specified in one
|
|
argument as a string using a :ref:`semicolon-separated list
|
|
<CMake Language Lists>`.
|
|
|
|
``<variable>``
|
|
Variable name of an internal cache variable to store the result of the
|
|
check, with boolean true for success and boolean false for failure.
|
|
|
|
A successful result only indicates that the compiler did not report an
|
|
error when given the flag. Whether the flag has any effect, or the
|
|
intended one, is outside the scope of this module.
|
|
|
|
.. note::
|
|
|
|
Since the underlying :command:`try_compile` command also uses flags from
|
|
variables like :variable:`CMAKE_<LANG>_FLAGS`, unknown or unsupported
|
|
flags in those variables may result in a false negative for this check.
|
|
|
|
.. rubric:: Variables Affecting the Check
|
|
|
|
The following variables may be set before calling this command to modify
|
|
the way the check is run:
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst
|
|
|
|
.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst
|
|
|
|
.. include:: /module/include/CMAKE_TRY_COMPILE_TARGET_TYPE.rst
|
|
|
|
Examples
|
|
^^^^^^^^
|
|
|
|
The following example demonstrates how to use this module to check support
|
|
for the C compiler flag ``-fno-optimize-strlen``, which disables
|
|
optimizations related to the ``strlen()`` C function in GCC and Clang
|
|
compilers. The result of the check is stored in the internal cache
|
|
variable ``HAVE_FNO_OPTIMIZE_STRLEN``, and the flag is conditionally enabled
|
|
using the :command:`target_compile_options` command. The
|
|
:genex:`$<COMPILE_LANGUAGE:...> <COMPILE_LANGUAGE:languages>` generator
|
|
expression ensures that the flag is added only to ``C`` source files.
|
|
|
|
.. code-block:: cmake
|
|
|
|
include(CheckCompilerFlag)
|
|
check_compiler_flag(C -fno-optimize-strlen HAVE_FNO_OPTIMIZE_STRLEN)
|
|
|
|
if(HAVE_FNO_OPTIMIZE_STRLEN)
|
|
target_compile_options(
|
|
example
|
|
PRIVATE $<$<COMPILE_LANGUAGE:C>:-fno-optimize-strlen>
|
|
)
|
|
endif()
|
|
|
|
See Also
|
|
^^^^^^^^
|
|
|
|
* The :module:`CheckLinkerFlag` module to check whether a linker flag is
|
|
supported by the compiler.
|
|
#]=======================================================================]
|
|
|
|
include_guard(GLOBAL)
|
|
include(Internal/CheckCompilerFlag)
|
|
|
|
function(CHECK_COMPILER_FLAG _lang _flag _var)
|
|
cmake_check_compiler_flag(${_lang} "${_flag}" ${_var})
|
|
endfunction()
|