mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-04 04:40:56 -06:00
c2efb3efcd
Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
55 lines
1.8 KiB
ReStructuredText
55 lines
1.8 KiB
ReStructuredText
get_filename_component
|
|
----------------------
|
|
|
|
Get a specific component of a full filename.
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_filename_component(<var> <FileName> <mode> [CACHE])
|
|
|
|
Sets ``<var>`` to a component of ``<FileName>``, where ``<mode>`` is one of:
|
|
|
|
::
|
|
|
|
DIRECTORY = Directory without file name
|
|
NAME = File name without directory
|
|
EXT = File name longest extension (.b.c from d/a.b.c)
|
|
NAME_WE = File name without directory or longest extension
|
|
PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)
|
|
|
|
Paths are returned with forward slashes and have no trailing slashes.
|
|
The longest file extension is always considered. If the optional
|
|
``CACHE`` argument is specified, the result variable is added to the
|
|
cache.
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_filename_component(<var> <FileName> <mode> [BASE_DIR <dir>] [CACHE])
|
|
|
|
Sets ``<var>`` to the absolute path of ``<FileName>``, where ``<mode>`` is one
|
|
of:
|
|
|
|
::
|
|
|
|
ABSOLUTE = Full path to file
|
|
REALPATH = Full path to existing file with symlinks resolved
|
|
|
|
If the provided ``<FileName>`` is a relative path, it is evaluated relative
|
|
to the given base directory ``<dir>``. If no base directory is
|
|
provided, the default base directory will be
|
|
:variable:`CMAKE_CURRENT_SOURCE_DIR`.
|
|
|
|
Paths are returned with forward slashes and have no trailing slashes. If the
|
|
optional ``CACHE`` argument is specified, the result variable is added to the
|
|
cache.
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_filename_component(<var> <FileName> PROGRAM [PROGRAM_ARGS <arg_var>] [CACHE])
|
|
|
|
The program in ``<FileName>`` will be found in the system search path or
|
|
left as a full path. If ``PROGRAM_ARGS`` is present with ``PROGRAM``, then
|
|
any command-line arguments present in the ``<FileName>`` string are split
|
|
from the program name and stored in ``<arg_var>``. This is used to
|
|
separate a program name from its arguments in a command line string.
|