Help: Reformat cmake-generator-expressions.7 manual
Use definition lists instead of a preformatted block to enumerate the genex documentation. Consistently capitalize the description. Use ``...`` to format genex parameters in the description. Turn references to commands into links. Add high level documentation about the motivation for generator expressions. Regroup expressions into subsections for different genex types. Add a high-level description and example of the expressions in each section. Explode the documentation for filesystem artifacts, instead of only referring to the variations.
This commit is contained in:
Stephen Kelly
Brad King
parent
d46dfd32c6
commit
8e729df0fc
|
|
@ -7,80 +7,174 @@ cmake-generator-expressions(7)
|
|||
|
||||
.. contents::
|
||||
|
||||
Generator Expressions
|
||||
=====================
|
||||
Introduction
|
||||
============
|
||||
|
||||
Generator expressions are evaluated during build
|
||||
system generation to produce information specific to each build
|
||||
configuration. Valid expressions are:
|
||||
Generator expressions are evaluated during build system generation to produce
|
||||
information specific to each build configuration.
|
||||
|
||||
::
|
||||
Generator expressions are allowed in the context of many target properties,
|
||||
such as :prop_tgt:`LINK_LIBRARIES`, :prop_tgt:`INCLUDE_DIRECTORIES`,
|
||||
:prop_tgt:`COMPILE_DEFINITIONS` and others. They may also be used when using
|
||||
commands to populate those properties, such as :command:`target_link_libraries`,
|
||||
:command:`target_include_directories`, :command:`target_compile_definitions`
|
||||
and others.
|
||||
|
||||
$<0:...> = empty string (ignores "...")
|
||||
$<1:...> = content of "..."
|
||||
$<CONFIG:cfg> = '1' if config is "cfg", else '0'
|
||||
$<CONFIGURATION> = configuration name
|
||||
$<BOOL:...> = '1' if the '...' is true, else '0'
|
||||
$<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0'
|
||||
$<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example.
|
||||
$<COMMA> = A literal ','. Used to compare strings which contain a ',' for example.
|
||||
$<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'.
|
||||
$<JOIN:list,...> = joins the list with the content of "..."
|
||||
$<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions.
|
||||
$<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise.
|
||||
$<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise.
|
||||
$<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'.
|
||||
$<C_COMPILER_ID> = The CMake-id of the C compiler used.
|
||||
$<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'.
|
||||
$<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used.
|
||||
$<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'.
|
||||
$<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'.
|
||||
$<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'.
|
||||
$<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'.
|
||||
$<C_COMPILER_VERSION> = The version of the C compiler used.
|
||||
$<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'.
|
||||
$<CXX_COMPILER_VERSION> = The version of the CXX compiler used.
|
||||
$<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'.
|
||||
$<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a)
|
||||
$<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)
|
||||
$<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)
|
||||
This means that they enable conditional linking, conditional
|
||||
definitions used when compiling, and conditional include directories and
|
||||
more. The conditions may be based on the build configuration, target
|
||||
properties, platform information or any other queryable information.
|
||||
|
||||
where "tgt" is the name of a target. Target file expressions produce
|
||||
a full path, but _DIR and _NAME versions can produce the directory and
|
||||
file name components:
|
||||
Logical Expressions
|
||||
===================
|
||||
|
||||
::
|
||||
Logical expressions are used to create conditional output. The basic
|
||||
expressions are the ``0`` and ``1`` expressions. Because other logical
|
||||
expressions evaluate to either ``0`` or ``1``, they can be composed to
|
||||
create conditional output::
|
||||
|
||||
$<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>
|
||||
$<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>
|
||||
$<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>
|
||||
$<$<CONFIG:Debug>:DEBUG_MODE>
|
||||
|
||||
expands to ``DEBUG_MODE`` when the ``Debug`` configuration is used, and
|
||||
otherwise expands to nothing.
|
||||
|
||||
``$<0:...>``
|
||||
Empty string (ignores ``...``)
|
||||
``$<1:...>``
|
||||
Content of ``...``
|
||||
``$<BOOL:...>``
|
||||
``1`` if the ``...`` is true, else ``0``
|
||||
``$<AND:?[,?]...>``
|
||||
``1`` if all ``?`` are ``1``, else ``0``
|
||||
|
||||
::
|
||||
The ``?`` must always be either ``0`` or ``1`` in boolean expressions.
|
||||
|
||||
$<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt.
|
||||
``$<OR:?[,?]...>``
|
||||
``0`` if all ``?`` are ``0``, else ``1``
|
||||
``$<NOT:?>``
|
||||
``0`` if ``?`` is ``1``, else ``1``
|
||||
``$<STREQUAL:a,b>``
|
||||
``1`` if ``a`` is STREQUAL ``b``, else ``0``
|
||||
``$<CONFIG:cfg>``
|
||||
``1`` if config is ``cfg``, else ``0``. This is a case-insensitive comparison.
|
||||
The mapping in :prop_tgt:`MAP_IMPORTED_CONFIG_<CONFIG>` is also considered by
|
||||
this expression when it is evaluated on a property on an :prop_tgt:`IMPORTED`
|
||||
target.
|
||||
``$<PLATFORM_ID:comp>``
|
||||
``1`` if the CMake-id of the platform matches ``comp``, otherwise ``0``.
|
||||
``$<C_COMPILER_ID:comp>``
|
||||
``1`` if the CMake-id of the C compiler matches ``comp``, otherwise ``0``.
|
||||
``$<CXX_COMPILER_ID:comp>``
|
||||
``1`` if the CMake-id of the CXX compiler matches ``comp``, otherwise ``0``.
|
||||
``$<VERSION_GREATER:v1,v2>``
|
||||
``1`` if ``v1`` is a version greater than ``v2``, else ``0``.
|
||||
``$<VERSION_LESS:v1,v2>``
|
||||
``1`` if ``v1`` is a version less than ``v2``, else ``0``.
|
||||
``$<VERSION_EQUAL:v1,v2>``
|
||||
``1`` if ``v1`` is the same version as ``v2``, else ``0``.
|
||||
``$<C_COMPILER_VERSION:ver>``
|
||||
``1`` if the version of the C compiler matches ``ver``, otherwise ``0``.
|
||||
``$<CXX_COMPILER_VERSION:ver>``
|
||||
``1`` if the version of the CXX compiler matches ``ver``, otherwise ``0``.
|
||||
``$<TARGET_POLICY:pol>``
|
||||
``1`` if the policy ``pol`` was NEW when the 'head' target was created,
|
||||
else ``0``. If the policy was not set, the warning message for the policy
|
||||
will be emitted. This generator expression only works for a subset of
|
||||
policies.
|
||||
|
||||
Note that tgt is not added as a dependency of the target this
|
||||
expression is evaluated on.
|
||||
Informational Expressions
|
||||
=========================
|
||||
|
||||
::
|
||||
These expressions expand to some information. The information may be used
|
||||
directly, eg::
|
||||
|
||||
$<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies.
|
||||
$<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise.
|
||||
include_directories(/usr/include/$<CXX_COMPILER_ID>/)
|
||||
|
||||
Boolean expressions:
|
||||
expands to ``/usr/include/GNU/`` or ``/usr/include/Clang/`` etc, depending on
|
||||
the Id of the compiler.
|
||||
|
||||
::
|
||||
These expressions may also may be combined with logical expressions::
|
||||
|
||||
$<AND:?[,?]...> = '1' if all '?' are '1', else '0'
|
||||
$<OR:?[,?]...> = '0' if all '?' are '0', else '1'
|
||||
$<NOT:?> = '0' if '?' is '1', else '1'
|
||||
$<$<VERSION_LESS:$<CXX_COMPILER_VERSION>,4.2.0>:OLD_COMPILER>
|
||||
|
||||
where '?' is always either '0' or '1'.
|
||||
expands to ``OLD_COMPILER`` if the
|
||||
:variable:`CMAKE_CXX_COMPILER_VERSION <CMAKE_<LANG>_COMPILER_VERSION>` is less
|
||||
than 4.2.0.
|
||||
|
||||
Expressions with an implicit 'this' target:
|
||||
``$<CONFIGURATION>``
|
||||
Configuration name
|
||||
``$<PLATFORM_ID>``
|
||||
The CMake-id of the platform
|
||||
``$<C_COMPILER_ID>``
|
||||
The CMake-id of the C compiler used.
|
||||
``$<CXX_COMPILER_ID>``
|
||||
The CMake-id of the CXX compiler used.
|
||||
``$<C_COMPILER_VERSION>``
|
||||
The version of the C compiler used.
|
||||
``$<CXX_COMPILER_VERSION>``
|
||||
The version of the CXX compiler used.
|
||||
``$<TARGET_FILE:tgt>``
|
||||
Full path to main file (.exe, .so.1.2, .a) where ``tgt`` is the name of a target.
|
||||
``$<TARGET_FILE_NAME:tgt>``
|
||||
Name of main file (.exe, .so.1.2, .a).
|
||||
``$<TARGET_FILE_DIR:tgt>``
|
||||
Directory of main file (.exe, .so.1.2, .a).
|
||||
``$<TARGET_LINKER_FILE:tgt>``
|
||||
File used to link (.a, .lib, .so) where ``tgt`` is the name of a target.
|
||||
``$<TARGET_LINKER_FILE_NAME:tgt>``
|
||||
Name of file used to link (.a, .lib, .so).
|
||||
``$<TARGET_LINKER_FILE_DIR:tgt>``
|
||||
Directory of file used to link (.a, .lib, .so).
|
||||
``$<TARGET_SONAME_FILE:tgt>``
|
||||
File with soname (.so.3) where ``tgt`` is the name of a target.
|
||||
``$<TARGET_SONAME_FILE_NAME:tgt>``
|
||||
Name of file with soname (.so.3).
|
||||
``$<TARGET_SONAME_FILE_DIR:tgt>``
|
||||
Directory of with soname (.so.3).
|
||||
``$<TARGET_PROPERTY:tgt,prop>``
|
||||
Value of the property ``prop`` on the target ``tgt``.
|
||||
|
||||
::
|
||||
Note that ``tgt`` is not added as a dependency of the target this
|
||||
expression is evaluated on.
|
||||
``$<TARGET_PROPERTY:prop>``
|
||||
Value of the property ``prop`` on the target on which the generator
|
||||
expression is evaluated.
|
||||
``$<INSTALL_PREFIX>``
|
||||
Content of the install prefix when the target is exported via
|
||||
:command:`install(EXPORT)` and empty otherwise.
|
||||
|
||||
$<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated.
|
||||
Output Expressions
|
||||
==================
|
||||
|
||||
These expressions generate output, in some cases depending on an input. These
|
||||
expressions may be combined with other expressions for information or logical
|
||||
comparison::
|
||||
|
||||
-I$<JOIN:$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>, -I>
|
||||
|
||||
generates a string of the entries in the :prop_tgt:`INCLUDE_DIRECTORIES` target
|
||||
property with each entry preceeded by ``-I``. Note that a more-complete use
|
||||
in this situation would be require first checking if the INCLUDE_DIRECTORIES
|
||||
property is non-empty::
|
||||
|
||||
$<$<BOOL:$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>>:-I$<JOIN:$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>, -I>>
|
||||
|
||||
``$<JOIN:list,...>``
|
||||
Joins the list with the content of ``...``
|
||||
``$<ANGLE-R>``
|
||||
A literal ``>``. Used to compare strings which contain a ``>`` for example.
|
||||
``$<COMMA>``
|
||||
A literal ``,``. Used to compare strings which contain a ``,`` for example.
|
||||
``$<SEMICOLON>``
|
||||
A literal ``;``. Used to prevent list expansion on an argument with ``;``.
|
||||
``$<TARGET_NAME:...>``
|
||||
Marks ``...`` as being the name of a target. This is required if exporting
|
||||
targets to multiple dependent export sets. The ``...`` must be a literal
|
||||
name of a target- it may not contain generator expressions.
|
||||
``$<INSTALL_INTERFACE:...>``
|
||||
Content of ``...`` when the property is exported using :command:`install(EXPORT)`,
|
||||
and empty otherwise.
|
||||
``$<BUILD_INTERFACE:...>``
|
||||
Content of ``...`` when the property is exported using :command:`export`, or
|
||||
when the target is used by another target in the same buildsystem. Expands to
|
||||
the empty string otherwise.
|
||||
|
|
|
|||
Loading…
Reference in New Issue