summaryrefslogtreecommitdiff
path: root/Help/command/get_filename_component.rst
blob: 60488dad5de1ba79645802646df1ac674c80d774 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
get_filename_component
----------------------

Get a specific component of a full filename.

::

  get_filename_component(<VAR> <FileName> <COMP> [CACHE])

Set ``<VAR>`` to a component of ``<FileName>``, where ``<COMP>`` 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
 ABSOLUTE  = Full path to file
 REALPATH  = Full path to existing file with symlinks resolved
 PATH      = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)

Paths are returned with forward slashes and have no trailing slahes.
The longest file extension is always considered.  If the optional
``CACHE`` argument is specified, the result variable is added to the
cache.

::

  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.