OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 add_compile_definitions.html	8.97 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_compile_options.html	13.11 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_custom_command.html	67.2 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_custom_target.html	26.7 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_definitions.html	9.72 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_dependencies.html	8.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_executable.html	20.23 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_library.html	43.25 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_link_options.html	17.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_subdirectory.html	8.85 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_test.html	17.09 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 aux_source_directory.html	6.45 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 block.html	13.15 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 break.html	5.97 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_command.html	10.66 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_name.html	6.43 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_host_system_information.html	38.46 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_language.html	59.74 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_minimum_required.html	13.56 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_parse_arguments.html	18.62 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_path.html	80.45 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_policy.html	23.14 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 configure_file.html	20.36 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 continue.html	6.15 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 create_test_sourcelist.html	7.61 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_build.html	14.87 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_configure.html	10.28 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_coverage.html	9.93 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_empty_binary_directory.html	5.54 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_memcheck.html	11.73 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_read_custom_files.html	5.78 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_run_script.html	6.72 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_sleep.html	5.66 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_start.html	14.68 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_submit.html	16.18 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_test.html	38.64 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_update.html	8.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_upload.html	6.7 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 define_property.html	15.53 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 else.html	5.35 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 elseif.html	5.44 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_language.html	10.08 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_testing.html	6.04 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endblock.html	5.66 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endforeach.html	5.88 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endfunction.html	5.85 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endif.html	5.71 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endmacro.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endwhile.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 exec_program.html	7.52 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 execute_process.html	20.95 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export.html	19.49 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export_library_dependencies.html	8.01 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 file.html	128.25 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_file.html	39.65 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_library.html	46.52 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_package.html	91.29 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_path.html	40.22 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_program.html	37.17 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 fltk_wrap_ui.html	5.8 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 foreach.html	18.65 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 function.html	12.42 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_cmake_property.html	8.05 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_directory_property.html	9.08 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_filename_component.html	12.57 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_property.html	15.95 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_source_file_property.html	11.47 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_target_property.html	9.1 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_test_property.html	8.06 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 if.html	41.89 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include.html	8.04 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_directories.html	10.54 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_external_msproject.html	8.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_guard.html	8.85 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_regular_expression.html	6.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install.html	126.44 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_files.html	9.13 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_programs.html	9.09 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_targets.html	7 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_directories.html	11.99 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_libraries.html	7.36 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 list.html	35.79 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_cache.html	6.78 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_command.html	6.61 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 macro.html	20.49 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 make_directory.html	5.77 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 mark_as_advanced.html	6.73 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 math.html	9.01 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 message.html	27.67 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 option.html	6.48 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 output_required_files.html	6.59 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 project.html	30.84 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_cpp.html	7.2 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_ui.html	7.43 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove.html	6 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove_definitions.html	6.15 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 return.html	16.06 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 separate_arguments.html	11.04 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set.html	18.35 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_directory_properties.html	7.58 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_property.html	17.74 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_source_files_properties.html	10.63 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_target_properties.html	8.33 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_tests_properties.html	7.98 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 site_name.html	5.46 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 source_group.html	10.97 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 string.html	64.24 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdir_depends.html	5.69 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdirs.html	7.51 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_definitions.html	16.09 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_features.html	14.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_options.html	18.02 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_include_directories.html	22.39 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_directories.html	16.03 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_libraries.html	60.83 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_options.html	23.66 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_precompile_headers.html	24.42 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_sources.html	38.35 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_compile.html	57.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_run.html	24.62 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 unset.html	9.21 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 use_mangled_mesa.html	5.91 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 utility_source.html	6.78 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_requires.html	6.84 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_watch.html	8.98 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 while.html	9.14 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 write_file.html	7.25 KB	04/04/2023 07:05:04 PM	rw-r--r--

Editing: cmake_path.html

<!DOCTYPE html>

<title>cmake_path &mdash; CMake 3.26.3 Documentation</title>

</head><body>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="cmake_policy.html" title="cmake_policy"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="cmake_parse_arguments.html" title="cmake_parse_arguments"
 accesskey="P">previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">cmake_path</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="cmake-path">
<h1>cmake_path<a class="headerlink" href="#cmake-path" title="Permalink to this heading">¶</a></h1>
<div class="versionadded">
New in version 3.20.
</div>
This command is for the manipulation of paths. Only syntactic aspects of
paths are handled, there is no interaction of any kind with any underlying
file system. The path may represent a non-existing path or even one that
is not allowed to exist on the current file system or platform.
For operations that do interact with the filesystem, see the <a class="reference internal" href="file.html#command:file" title="file"><code class="xref cmake cmake-command docutils literal notranslate">file()</code></a>
command.
<div class="admonition note">
Note
The <code class="docutils literal notranslate">cmake_path</code> command handles paths in the format of the build system
(i.e. the host platform), not the target system. When cross-compiling,
if the path contains elements that are not representable on the host
platform (e.g. a drive letter when the host is not Windows), the results
will be unpredictable.
</div>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
<pre class="literal-block"><a class="reference internal" href="#conventions">Conventions</a>

<a class="reference internal" href="#path-structure-and-terminology">Path Structure And Terminology</a>

<a class="reference internal" href="#normalization">Normalization</a>

<a class="reference internal" href="#decomposition">Decomposition</a>
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-root-name">ROOT_NAME</a> &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-root-directory">ROOT_DIRECTORY</a> &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-root-path">ROOT_PATH</a> &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-filename">FILENAME</a> &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-extension">EXTENSION</a> [LAST_ONLY] &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-stem">STEM</a> [LAST_ONLY] &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-relative-part">RELATIVE_PART</a> &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#get">GET</a> &lt;path-var&gt; <a class="reference internal" href="#get-parent-path">PARENT_PATH</a> &lt;out-var&gt;)

<a class="reference internal" href="#query">Query</a>
 cmake_path(<a class="reference internal" href="#has-root-name">HAS_ROOT_NAME</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#has-root-directory">HAS_ROOT_DIRECTORY</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#has-root-path">HAS_ROOT_PATH</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#has-filename">HAS_FILENAME</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#has-extension">HAS_EXTENSION</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#has-stem">HAS_STEM</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#has-relative-part">HAS_RELATIVE_PART</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#has-parent-path">HAS_PARENT_PATH</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#is-absolute">IS_ABSOLUTE</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#is-relative">IS_RELATIVE</a> &lt;path-var&gt; &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#is-prefix">IS_PREFIX</a> &lt;path-var&gt; &lt;input&gt; [NORMALIZE] &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#compare">COMPARE</a> &lt;input1&gt; &lt;OP&gt; &lt;input2&gt; &lt;out-var&gt;)

<a class="reference internal" href="#modification">Modification</a>
 cmake_path(<a class="reference internal" href="#cmake-path-set">SET</a> &lt;path-var&gt; [NORMALIZE] &lt;input&gt;)
 cmake_path(<a class="reference internal" href="#append">APPEND</a> &lt;path-var&gt; [&lt;input&gt;...] [OUTPUT_VARIABLE &lt;out-var&gt;])
 cmake_path(<a class="reference internal" href="#append-string">APPEND_STRING</a> &lt;path-var&gt; [&lt;input&gt;...] [OUTPUT_VARIABLE &lt;out-var&gt;])
 cmake_path(<a class="reference internal" href="#remove-filename">REMOVE_FILENAME</a> &lt;path-var&gt; [OUTPUT_VARIABLE &lt;out-var&gt;])
 cmake_path(<a class="reference internal" href="#replace-filename">REPLACE_FILENAME</a> &lt;path-var&gt; &lt;input&gt; [OUTPUT_VARIABLE &lt;out-var&gt;])
 cmake_path(<a class="reference internal" href="#remove-extension">REMOVE_EXTENSION</a> &lt;path-var&gt; [LAST_ONLY] [OUTPUT_VARIABLE &lt;out-var&gt;])
 cmake_path(<a class="reference internal" href="#replace-extension">REPLACE_EXTENSION</a> &lt;path-var&gt; [LAST_ONLY] &lt;input&gt; [OUTPUT_VARIABLE &lt;out-var&gt;])

<a class="reference internal" href="#generation">Generation</a>
 cmake_path(<a class="reference internal" href="#normal-path">NORMAL_PATH</a> &lt;path-var&gt; [OUTPUT_VARIABLE &lt;out-var&gt;])
 cmake_path(<a class="reference internal" href="#relative-path">RELATIVE_PATH</a> &lt;path-var&gt; [BASE_DIRECTORY &lt;input&gt;] [OUTPUT_VARIABLE &lt;out-var&gt;])
 cmake_path(<a class="reference internal" href="#absolute-path">ABSOLUTE_PATH</a> &lt;path-var&gt; [BASE_DIRECTORY &lt;input&gt;] [NORMALIZE] [OUTPUT_VARIABLE &lt;out-var&gt;])

<a class="reference internal" href="#native-conversion">Native Conversion</a>
 cmake_path(<a class="reference internal" href="#native-path">NATIVE_PATH</a> &lt;path-var&gt; [NORMALIZE] &lt;out-var&gt;)
 cmake_path(<a class="reference internal" href="#convert">CONVERT</a> &lt;input&gt; <a class="reference internal" href="#to-cmake-path-list">TO_CMAKE_PATH_LIST</a> &lt;out-var&gt; [NORMALIZE])
 cmake_path(<a class="reference internal" href="#convert">CONVERT</a> &lt;input&gt; <a class="reference internal" href="#to-native-path-list">TO_NATIVE_PATH_LIST</a> &lt;out-var&gt; [NORMALIZE])

<a class="reference internal" href="#hashing">Hashing</a>
 cmake_path(<a class="reference internal" href="#hash">HASH</a> &lt;path-var&gt; &lt;out-var&gt;)</pre>
</section>
<section id="conventions">
<h2>Conventions<a class="headerlink" href="#conventions" title="Permalink to this heading">¶</a></h2>
The following conventions are used in this command's documentation:
<dl class="simple">
<dt><code class="docutils literal notranslate">&lt;path-var&gt;</code></dt><dd>Always the name of a variable. For commands that expect a <code class="docutils literal notranslate">&lt;path-var&gt;</code>
as input, the variable must exist and it is expected to hold a single path.
</dd>
<dt><code class="docutils literal notranslate">&lt;input&gt;</code></dt><dd>A string literal which may contain a path, path fragment, or multiple paths
with a special separator depending on the command. See the description of
each command to see how this is interpreted.
</dd>
<dt><code class="docutils literal notranslate">&lt;input&gt;...</code></dt><dd>Zero or more string literal arguments.
</dd>
<dt><code class="docutils literal notranslate">&lt;out-var&gt;</code></dt><dd>The name of a variable into which the result of a command will be written.
</dd>
</dl>
</section>
<section id="path-structure-and-terminology">
<h2>Path Structure And Terminology<a class="headerlink" href="#path-structure-and-terminology" title="Permalink to this heading">¶</a></h2>
A path has the following structure (all components are optional, with some
constraints):
<div class="highlight-none notranslate"><div class="highlight"><pre>root-name root-directory-separator (item-name directory-separator)* filename
</pre></div>
</div>
<dl>
<dt><code class="docutils literal notranslate">root-name</code></dt><dd>Identifies the root on a filesystem with multiple roots (such as <code class="docutils literal notranslate">&quot;C:&quot;</code>
or <code class="docutils literal notranslate">&quot;//myserver&quot;</code>). It is optional.
</dd>
<dt><code class="docutils literal notranslate">root-directory-separator</code></dt><dd>A directory separator that, if present, indicates that this path is
absolute. If it is missing and the first element other than the
<code class="docutils literal notranslate">root-name</code> is an <code class="docutils literal notranslate">item-name</code>, then the path is relative.
</dd>
<dt><code class="docutils literal notranslate">item-name</code></dt><dd>A sequence of characters that aren't directory separators. This name may
identify a file, a hard link, a symbolic link, or a directory. Two special
cases are recognized:
<blockquote>
<div><ul class="simple">
<li>The item name consisting of a single dot character <code class="docutils literal notranslate">.</code> is a
directory name that refers to the current directory.</li>
<li>The item name consisting of two dot characters <code class="docutils literal notranslate">..</code> is a
directory name that refers to the parent directory.</li>
</ul>
</div></blockquote>
The <code class="docutils literal notranslate">(...)*</code> pattern shown above is to indicate that there can be zero
or more item names, with multiple items separated by a
<code class="docutils literal notranslate">directory-separator</code>. The <code class="docutils literal notranslate">()*</code> characters are not part of the path.
</dd>
<dt><code class="docutils literal notranslate">directory-separator</code></dt><dd>The only recognized directory separator is a forward slash character <code class="docutils literal notranslate">/</code>.
If this character is repeated, it is treated as a single directory
separator. In other words, <code class="docutils literal notranslate">/usr///////lib</code> is the same as <code class="docutils literal notranslate">/usr/lib</code>.
</dd>
</dl>
<dl id="stem-def">
<dt><code class="docutils literal notranslate">filename</code></dt><dd>A path has a <code class="docutils literal notranslate">filename</code> if it does not end with a <code class="docutils literal notranslate">directory-separator</code>.
The <code class="docutils literal notranslate">filename</code> is effectively the last <code class="docutils literal notranslate">item-name</code> of the path, so it
can also be a hard link, symbolic link or a directory.
A <code class="docutils literal notranslate">filename</code> can have an extension. By default, the extension is
defined as the sub-string beginning at the left-most period (including
the period) and until the end of the <code class="docutils literal notranslate">filename</code>. In commands that
accept a <code class="docutils literal notranslate">LAST_ONLY</code> keyword, <code class="docutils literal notranslate">LAST_ONLY</code> changes the interpretation
to the sub-string beginning at the right-most period.
The following exceptions apply to the above interpretation:
<blockquote>
<div><ul class="simple">
<li>If the first character in the <code class="docutils literal notranslate">filename</code> is a period, that period is
ignored (i.e. a <code class="docutils literal notranslate">filename</code> like <code class="docutils literal notranslate">&quot;.profile&quot;</code> is treated as having
no extension).</li>
<li>If the <code class="docutils literal notranslate">filename</code> is either <code class="docutils literal notranslate">.</code> or <code class="docutils literal notranslate">..</code>, it has no extension.</li>
</ul>
</div></blockquote>
The stem is the part of the <code class="docutils literal notranslate">filename</code> before the extension.
</dd>
</dl>
Some commands refer to a <code class="docutils literal notranslate">root-path</code>. This is the concatenation of
<code class="docutils literal notranslate">root-name</code> and <code class="docutils literal notranslate">root-directory-separator</code>, either or both of which can
be empty. A <code class="docutils literal notranslate">relative-part</code> refers to the full path with any <code class="docutils literal notranslate">root-path</code>
removed.
</section>
<section id="creating-a-path-variable">
<h2>Creating A Path Variable<a class="headerlink" href="#creating-a-path-variable" title="Permalink to this heading">¶</a></h2>
While a path can be created with care using an ordinary <a class="reference internal" href="set.html#command:set" title="set"><code class="xref cmake cmake-command docutils literal notranslate">set()</code></a>
command, it is recommended to use <a class="reference internal" href="#cmake-path-set">cmake_path(SET)</a>
instead, as it automatically converts the path to the required form where
required. The <a class="reference internal" href="string.html#append">cmake_path(APPEND)</a> subcommand may
be another suitable alternative where a path needs to be constructed by
joining fragments. The following example compares the three methods for
constructing the same path:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path1 &quot;${CMAKE_CURRENT_SOURCE_DIR}/data&quot;)

cmake_path(SET path2 &quot;${CMAKE_CURRENT_SOURCE_DIR}/data&quot;)

cmake_path(APPEND path3 &quot;${CMAKE_CURRENT_SOURCE_DIR}&quot; &quot;data&quot;)
</pre></div>
</div>
<a class="reference internal" href="#modification">Modification</a> and <a class="reference internal" href="#generation">Generation</a> sub-commands can either store the result
in-place, or in a separate variable named after an <code class="docutils literal notranslate">OUTPUT_VARIABLE</code>
keyword. All other sub-commands store the result in a mandatory <code class="docutils literal notranslate">&lt;out-var&gt;</code>
variable.
</section>
<section id="normalization">
<h2>Normalization<a class="headerlink" href="#normalization" title="Permalink to this heading">¶</a></h2>
Some sub-commands support normalizing a path. The algorithm used to
normalize a path is as follows:
<ol class="arabic simple">
<li>If the path is empty, stop (the normalized form of an empty path is
also an empty path).</li>
<li>Replace each <code class="docutils literal notranslate">directory-separator</code>, which may consist of multiple
separators, with a single <code class="docutils literal notranslate">/</code> (<code class="docutils literal notranslate">/a///b&#160; --&gt; /a/b</code>).</li>
<li>Remove each solitary period (<code class="docutils literal notranslate">.</code>) and any immediately following
<code class="docutils literal notranslate">directory-separator</code> (<code class="docutils literal notranslate">/a/./b/. --&gt; /a/b</code>).</li>
<li>Remove each <code class="docutils literal notranslate">item-name</code> (other than <code class="docutils literal notranslate">..</code>) that is immediately
followed by a <code class="docutils literal notranslate">directory-separator</code> and a <code class="docutils literal notranslate">..</code>, along with any
immediately following <code class="docutils literal notranslate">directory-separator</code> (<code class="docutils literal notranslate">/a/b/../c --&gt; a/c</code>).</li>
<li>If there is a <code class="docutils literal notranslate">root-directory</code>, remove any <code class="docutils literal notranslate">..</code> and any
<code class="docutils literal notranslate">directory-separators</code> immediately following them. The parent of the
root directory is treated as still the root directory (<code class="docutils literal notranslate">/../a --&gt; /a</code>).</li>
<li>If the last <code class="docutils literal notranslate">item-name</code> is <code class="docutils literal notranslate">..</code>, remove any trailing
<code class="docutils literal notranslate">directory-separator</code> (<code class="docutils literal notranslate">../ --&gt; ..</code>).</li>
<li>If the path is empty by this stage, add a <code class="docutils literal notranslate">dot</code> (normal form of <code class="docutils literal notranslate">./</code>
is <code class="docutils literal notranslate">.</code>).</li>
</ol>
</section>
<section id="decomposition">
<h2>Decomposition<a class="headerlink" href="#decomposition" title="Permalink to this heading">¶</a></h2>
The following forms of the <code class="docutils literal notranslate">GET</code> subcommand each retrieve a different
component or group of components from a path. See
<a class="reference internal" href="#path-structure-and-terminology">Path Structure And Terminology</a> for the meaning of each path component.
<div class="highlight-cmake notranslate"><div class="highlight"><pre>cmake_path(GET &lt;path-var&gt; ROOT_NAME &lt;out-var&gt;)
cmake_path(GET &lt;path-var&gt; ROOT_DIRECTORY &lt;out-var&gt;)
cmake_path(GET &lt;path-var&gt; ROOT_PATH &lt;out-var&gt;)
cmake_path(GET &lt;path-var&gt; FILENAME &lt;out-var&gt;)
cmake_path(GET &lt;path-var&gt; EXTENSION [LAST_ONLY] &lt;out-var&gt;)
cmake_path(GET &lt;path-var&gt; STEM [LAST_ONLY] &lt;out-var&gt;)
cmake_path(GET &lt;path-var&gt; RELATIVE_PART &lt;out-var&gt;)
cmake_path(GET &lt;path-var&gt; PARENT_PATH &lt;out-var&gt;)
</pre></div>
</div>
If a requested component is not present in the path, an empty string will be
stored in <code class="docutils literal notranslate">&lt;out-var&gt;</code>. For example, only Windows systems have the concept
of a <code class="docutils literal notranslate">root-name</code>, so when the host machine is non-Windows, the <code class="docutils literal notranslate">ROOT_NAME</code>
subcommand will always return an empty string.
For <code class="docutils literal notranslate">PARENT_PATH</code>, if the <a class="reference internal" href="#has-relative-part">HAS_RELATIVE_PART</a> subcommand returns false,
the result is a copy of <code class="docutils literal notranslate">&lt;path-var&gt;</code>. Note that this implies that a root
directory is considered to have a parent, with that parent being itself.
Where <a class="reference internal" href="#has-relative-part">HAS_RELATIVE_PART</a> returns true, the result will essentially be
<code class="docutils literal notranslate">&lt;path-var&gt;</code> with one less element.
<section id="root-examples">
<h3>Root examples<a class="headerlink" href="#root-examples" title="Permalink to this heading">¶</a></h3>
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path &quot;c:/a&quot;)

cmake_path(GET path ROOT_NAME rootName)
cmake_path(GET path ROOT_DIRECTORY rootDir)
cmake_path(GET path ROOT_PATH rootPath)

message(&quot;Root name is \&quot;${rootName}\&quot;&quot;)
message(&quot;Root directory is \&quot;${rootDir}\&quot;&quot;)
message(&quot;Root path is \&quot;${rootPath}\&quot;&quot;)
</pre></div>
</div>
<div class="highlight-none notranslate"><div class="highlight"><pre>Root name is &quot;c:&quot;
Root directory is &quot;/&quot;
Root path is &quot;c:/&quot;
</pre></div>
</div>
</section>
<section id="filename-examples">
<h3>Filename examples<a class="headerlink" href="#filename-examples" title="Permalink to this heading">¶</a></h3>
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path &quot;/a/b&quot;)
cmake_path(GET path FILENAME filename)
message(&quot;First filename is \&quot;${filename}\&quot;&quot;)

# Trailing slash means filename is empty
set(path &quot;/a/b/&quot;)
cmake_path(GET path FILENAME filename)
message(&quot;Second filename is \&quot;${filename}\&quot;&quot;)
</pre></div>
</div>
<div class="highlight-none notranslate"><div class="highlight"><pre>First filename is &quot;b&quot;
Second filename is &quot;&quot;
</pre></div>
</div>
</section>
<section id="extension-and-stem-examples">
<h3>Extension and stem examples<a class="headerlink" href="#extension-and-stem-examples" title="Permalink to this heading">¶</a></h3>
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path &quot;name.ext1.ext2&quot;)

cmake_path(GET path EXTENSION fullExt)
cmake_path(GET path STEM fullStem)
message(&quot;Full extension is \&quot;${fullExt}\&quot;&quot;)
message(&quot;Full stem is \&quot;${fullStem}\&quot;&quot;)

# Effect of LAST_ONLY
cmake_path(GET path EXTENSION LAST_ONLY lastExt)
cmake_path(GET path STEM LAST_ONLY lastStem)
message(&quot;Last extension is \&quot;${lastExt}\&quot;&quot;)
message(&quot;Last stem is \&quot;${lastStem}\&quot;&quot;)

# Special cases
set(dotPath &quot;/a/.&quot;)
set(dotDotPath &quot;/a/..&quot;)
set(someMorePath &quot;/a/.some.more&quot;)
cmake_path(GET dotPath EXTENSION dotExt)
cmake_path(GET dotPath STEM dotStem)
cmake_path(GET dotDotPath EXTENSION dotDotExt)
cmake_path(GET dotDotPath STEM dotDotStem)
cmake_path(GET dotMorePath EXTENSION someMoreExt)
cmake_path(GET dotMorePath STEM someMoreStem)
message(&quot;Dot extension is \&quot;${dotExt}\&quot;&quot;)
message(&quot;Dot stem is \&quot;${dotStem}\&quot;&quot;)
message(&quot;Dot-dot extension is \&quot;${dotDotExt}\&quot;&quot;)
message(&quot;Dot-dot stem is \&quot;${dotDotStem}\&quot;&quot;)
message(&quot;.some.more extension is \&quot;${someMoreExt}\&quot;&quot;)
message(&quot;.some.more stem is \&quot;${someMoreStem}\&quot;&quot;)
</pre></div>
</div>
<div class="highlight-none notranslate"><div class="highlight"><pre>Full extension is &quot;.ext1.ext2&quot;
Full stem is &quot;name&quot;
Last extension is &quot;.ext2&quot;
Last stem is &quot;name.ext1&quot;
Dot extension is &quot;&quot;
Dot stem is &quot;.&quot;
Dot-dot extension is &quot;&quot;
Dot-dot stem is &quot;..&quot;
.some.more extension is &quot;.more&quot;
.some.more stem is &quot;.some&quot;
</pre></div>
</div>
</section>
<section id="relative-part-examples">
<h3>Relative part examples<a class="headerlink" href="#relative-part-examples" title="Permalink to this heading">¶</a></h3>
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path &quot;c:/a/b&quot;)
cmake_path(GET path RELATIVE_PART result)
message(&quot;Relative part is \&quot;${result}\&quot;&quot;)

set(path &quot;c/d&quot;)
cmake_path(GET path RELATIVE_PART result)
message(&quot;Relative part is \&quot;${result}\&quot;&quot;)

set(path &quot;/&quot;)
cmake_path(GET path RELATIVE_PART result)
message(&quot;Relative part is \&quot;${result}\&quot;&quot;)
</pre></div>
</div>
<div class="highlight-none notranslate"><div class="highlight"><pre>Relative part is &quot;a/b&quot;
Relative part is &quot;c/d&quot;
Relative part is &quot;&quot;
</pre></div>
</div>
</section>
<section id="path-traversal-examples">
<h3>Path traversal examples<a class="headerlink" href="#path-traversal-examples" title="Permalink to this heading">¶</a></h3>
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path &quot;c:/a/b&quot;)
cmake_path(GET path PARENT_PATH result)
message(&quot;Parent path is \&quot;${result}\&quot;&quot;)

set(path &quot;c:/&quot;)
cmake_path(GET path PARENT_PATH result)
message(&quot;Parent path is \&quot;${result}\&quot;&quot;)
</pre></div>
</div>
<div class="highlight-none notranslate"><div class="highlight"><pre>Parent path is &quot;c:/a&quot;
Parent path is &quot;c:/&quot;
</pre></div>
</div>
</section>
</section>
<section id="query">
<h2>Query<a class="headerlink" href="#query" title="Permalink to this heading">¶</a></h2>
Each of the <code class="docutils literal notranslate">GET</code> subcommands has a corresponding <code class="docutils literal notranslate">HAS_...</code>
subcommand which can be used to discover whether a particular path
component is present. See <a class="reference internal" href="#path-structure-and-terminology">Path Structure And Terminology</a> for the
meaning of each path component.
<div class="highlight-cmake notranslate" id="has-parent-path"><div class="highlight"><pre>cmake_path(HAS_ROOT_NAME &lt;path-var&gt; &lt;out-var&gt;)
cmake_path(HAS_ROOT_DIRECTORY &lt;path-var&gt; &lt;out-var&gt;)
cmake_path(HAS_ROOT_PATH &lt;path-var&gt; &lt;out-var&gt;)
cmake_path(HAS_FILENAME &lt;path-var&gt; &lt;out-var&gt;)
cmake_path(HAS_EXTENSION &lt;path-var&gt; &lt;out-var&gt;)
cmake_path(HAS_STEM &lt;path-var&gt; &lt;out-var&gt;)
cmake_path(HAS_RELATIVE_PART &lt;path-var&gt; &lt;out-var&gt;)
cmake_path(HAS_PARENT_PATH &lt;path-var&gt; &lt;out-var&gt;)
</pre></div>
</div>
Each of the above follows the predictable pattern of setting <code class="docutils literal notranslate">&lt;out-var&gt;</code>
to true if the path has the associated component, or false otherwise.
Note the following special cases:
<ul class="simple">
<li>For <code class="docutils literal notranslate">HAS_ROOT_PATH</code>, a true result will only be returned if at least one
of <code class="docutils literal notranslate">root-name</code> or <code class="docutils literal notranslate">root-directory</code> is non-empty.</li>
<li>For <code class="docutils literal notranslate">HAS_PARENT_PATH</code>, the root directory is also considered to have a
parent, which will be itself. The result is true except if the path
consists of just a <a class="reference internal" href="#filename-def">filename</a>.</li>
</ul>
<div class="highlight-cmake notranslate" id="is-absolute"><div class="highlight"><pre>cmake_path(IS_ABSOLUTE &lt;path-var&gt; &lt;out-var&gt;)
</pre></div>
</div>
Sets <code class="docutils literal notranslate">&lt;out-var&gt;</code> to true if <code class="docutils literal notranslate">&lt;path-var&gt;</code> is absolute. An absolute path
is a path that unambiguously identifies the location of a file without
reference to an additional starting location. On Windows, this means the
path must have both a <code class="docutils literal notranslate">root-name</code> and a <code class="docutils literal notranslate">root-directory-separator</code> to be
considered absolute. On other platforms, just a <code class="docutils literal notranslate">root-directory-separator</code>
is sufficient. Note that this means on Windows, <code class="docutils literal notranslate">IS_ABSOLUTE</code> can be
false while <code class="docutils literal notranslate">HAS_ROOT_DIRECTORY</code> can be true.
<div class="highlight-cmake notranslate" id="is-relative"><div class="highlight"><pre>cmake_path(IS_RELATIVE &lt;path-var&gt; &lt;out-var&gt;)
</pre></div>
</div>
This will store the opposite of <code class="docutils literal notranslate">IS_ABSOLUTE</code> in <code class="docutils literal notranslate">&lt;out-var&gt;</code>.
<div class="highlight-cmake notranslate" id="is-prefix"><div class="highlight"><pre>cmake_path(IS_PREFIX &lt;path-var&gt; &lt;input&gt; [NORMALIZE] &lt;out-var&gt;)
</pre></div>
</div>
Checks if <code class="docutils literal notranslate">&lt;path-var&gt;</code> is the prefix of <code class="docutils literal notranslate">&lt;input&gt;</code>.
When the <code class="docutils literal notranslate">NORMALIZE</code> option is specified, <code class="docutils literal notranslate">&lt;path-var&gt;</code> and <code class="docutils literal notranslate">&lt;input&gt;</code>
are <a class="reference internal" href="#normalization">normalized</a> before the check.
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path &quot;/a/b/c&quot;)
cmake_path(IS_PREFIX path &quot;/a/b/c/d&quot; result) # result = true
cmake_path(IS_PREFIX path &quot;/a/b&quot; result) # result = false
cmake_path(IS_PREFIX path &quot;/x/y/z&quot; result) # result = false

set(path &quot;/a/b&quot;)
cmake_path(IS_PREFIX path &quot;/a/c/../b&quot; NORMALIZE result) # result = true
</pre></div>
</div>
<div class="highlight-cmake notranslate" id="compare"><div class="highlight"><pre>cmake_path(COMPARE &lt;input1&gt; EQUAL &lt;input2&gt; &lt;out-var&gt;)
cmake_path(COMPARE &lt;input1&gt; NOT_EQUAL &lt;input2&gt; &lt;out-var&gt;)
</pre></div>
</div>
Compares the lexical representations of two paths provided as string literals.
No normalization is performed on either path, except multiple consecutive
directory separators are effectively collapsed into a single separator.
Equality is determined according to the following pseudo-code logic:
<div class="highlight-none notranslate"><div class="highlight"><pre>if(NOT &lt;input1&gt;.root_name() STREQUAL &lt;input2&gt;.root_name())
 return FALSE

if(&lt;input1&gt;.has_root_directory() XOR &lt;input2&gt;.has_root_directory())
  return FALSE

Return FALSE if a relative portion of &lt;input1&gt; is not lexicographically
equal to the relative portion of &lt;input2&gt;. This comparison is performed path
component-wise. If all of the components compare equal, then return TRUE.
</pre></div>
</div>
<div class="admonition note">
Note
Unlike most other <code class="docutils literal notranslate">cmake_path()</code> subcommands, the <code class="docutils literal notranslate">COMPARE</code> subcommand
takes literal strings as input, not the names of variables.
</div>
</section>
<section id="modification">
<h2>Modification<a class="headerlink" href="#modification" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="cmake-path-set"><div class="highlight"><pre>cmake_path(SET &lt;path-var&gt; [NORMALIZE] &lt;input&gt;)
</pre></div>
</div>
Assign the <code class="docutils literal notranslate">&lt;input&gt;</code> path to <code class="docutils literal notranslate">&lt;path-var&gt;</code>. If <code class="docutils literal notranslate">&lt;input&gt;</code> is a native
path, it is converted into a cmake-style path with forward-slashes
(<code class="docutils literal notranslate">/</code>). On Windows, the long filename marker is taken into account.
When the <code class="docutils literal notranslate">NORMALIZE</code> option is specified, the path is <a class="reference internal" href="#normalization">normalized</a> after the conversion.
For example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(native_path &quot;c:\\a\\b/..\\c&quot;)
cmake_path(SET path &quot;${native_path}&quot;)
message(&quot;CMake path is \&quot;${path}\&quot;&quot;)

cmake_path(SET path NORMALIZE &quot;${native_path}&quot;)
message(&quot;Normalized CMake path is \&quot;${path}\&quot;&quot;)
</pre></div>
</div>
Output:
<div class="highlight-none notranslate"><div class="highlight"><pre>CMake path is &quot;c:/a/b/../c&quot;
Normalized CMake path is &quot;c:/a/c&quot;
</pre></div>
</div>
<div class="highlight-cmake notranslate" id="append"><div class="highlight"><pre>cmake_path(APPEND &lt;path-var&gt; [&lt;input&gt;...] [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Append all the <code class="docutils literal notranslate">&lt;input&gt;</code> arguments to the <code class="docutils literal notranslate">&lt;path-var&gt;</code> using <code class="docutils literal notranslate">/</code> as
the <code class="docutils literal notranslate">directory-separator</code>. Depending on the <code class="docutils literal notranslate">&lt;input&gt;</code>, the previous
contents of <code class="docutils literal notranslate">&lt;path-var&gt;</code> may be discarded. For each <code class="docutils literal notranslate">&lt;input&gt;</code> argument,
the following algorithm (pseudo-code) applies:
<div class="highlight-none notranslate"><div class="highlight"><pre># &lt;path&gt; is the contents of &lt;path-var&gt;

if(&lt;input&gt;.is_absolute() OR
   (&lt;input&gt;.has_root_name() AND
    NOT &lt;input&gt;.root_name() STREQUAL &lt;path&gt;.root_name()))
  replace &lt;path&gt; with &lt;input&gt;
  return()
endif()

if(&lt;input&gt;.has_root_directory())
  remove any root-directory and the entire relative path from &lt;path&gt;
elseif(&lt;path&gt;.has_filename() OR
       (NOT &lt;path-var&gt;.has_root_directory() OR &lt;path&gt;.is_absolute()))
  append directory-separator to &lt;path&gt;
endif()

append &lt;input&gt; omitting any root-name to &lt;path&gt;
</pre></div>
</div>
<div class="highlight-cmake notranslate" id="append-string"><div class="highlight"><pre>cmake_path(APPEND_STRING &lt;path-var&gt; [&lt;input&gt;...] [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Append all the <code class="docutils literal notranslate">&lt;input&gt;</code> arguments to the <code class="docutils literal notranslate">&lt;path-var&gt;</code> without adding any
<code class="docutils literal notranslate">directory-separator</code>.
<div class="highlight-cmake notranslate" id="remove-filename"><div class="highlight"><pre>cmake_path(REMOVE_FILENAME &lt;path-var&gt; [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Removes the <a class="reference internal" href="#filename-def">filename</a> component (as returned by
<a class="reference internal" href="#get-filename">GET ... FILENAME</a>) from <code class="docutils literal notranslate">&lt;path-var&gt;</code>. After removal,
any trailing <code class="docutils literal notranslate">directory-separator</code> is left alone, if present.
If <code class="docutils literal notranslate">OUTPUT_VARIABLE</code> is not given, then after this function returns,
<a class="reference internal" href="#has-filename">HAS_FILENAME</a> returns false for <code class="docutils literal notranslate">&lt;path-var&gt;</code>.
For example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(path &quot;/a/b&quot;)
cmake_path(REMOVE_FILENAME path)
message(&quot;First path is \&quot;${path}\&quot;&quot;)

# filename is now already empty, the following removes nothing
cmake_path(REMOVE_FILENAME path)
message(&quot;Second path is \&quot;${result}\&quot;&quot;)
</pre></div>
</div>
Output:
<div class="highlight-none notranslate"><div class="highlight"><pre>First path is &quot;/a/&quot;
Second path is &quot;/a/&quot;
</pre></div>
</div>
<div class="highlight-cmake notranslate" id="replace-filename"><div class="highlight"><pre>cmake_path(REPLACE_FILENAME &lt;path-var&gt; &lt;input&gt; [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Replaces the <a class="reference internal" href="#filename-def">filename</a> component from <code class="docutils literal notranslate">&lt;path-var&gt;</code>
with <code class="docutils literal notranslate">&lt;input&gt;</code>. If <code class="docutils literal notranslate">&lt;path-var&gt;</code> has no filename component (i.e.
<a class="reference internal" href="#has-filename">HAS_FILENAME</a> returns false), the path is unchanged. The operation is
equivalent to the following:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>cmake_path(HAS_FILENAME path has_filename)
if(has_filename)
 cmake_path(REMOVE_FILENAME path)
 cmake_path(APPEND path input);
endif()
</pre></div>
</div>
<div class="highlight-cmake notranslate" id="remove-extension"><div class="highlight"><pre>cmake_path(REMOVE_EXTENSION &lt;path-var&gt; [LAST_ONLY]
 [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Removes the <a class="reference internal" href="#extension-def">extension</a>, if any, from <code class="docutils literal notranslate">&lt;path-var&gt;</code>.
<div class="highlight-cmake notranslate" id="replace-extension"><div class="highlight"><pre>cmake_path(REPLACE_EXTENSION &lt;path-var&gt; [LAST_ONLY] &lt;input&gt;
 [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Replaces the <a class="reference internal" href="#extension-def">extension</a> with <code class="docutils literal notranslate">&lt;input&gt;</code>. Its effect
is equivalent to the following:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>cmake_path(REMOVE_EXTENSION path)
if(NOT &quot;input&quot; MATCHES &quot;^\\.&quot;)
 cmake_path(APPEND_STRING path &quot;.&quot;)
endif()
cmake_path(APPEND_STRING path &quot;input&quot;)
</pre></div>
</div>
</section>
<section id="generation">
<h2>Generation<a class="headerlink" href="#generation" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="normal-path"><div class="highlight"><pre>cmake_path(NORMAL_PATH &lt;path-var&gt; [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Normalize <code class="docutils literal notranslate">&lt;path-var&gt;</code> according the steps described in <a class="reference internal" href="#normalization">Normalization</a>.
<div class="highlight-cmake notranslate" id="relative-path"><div class="highlight"><pre>cmake_path(RELATIVE_PATH &lt;path-var&gt; [BASE_DIRECTORY &lt;input&gt;]
 [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
Modifies <code class="docutils literal notranslate">&lt;path-var&gt;</code> to make it relative to the <code class="docutils literal notranslate">BASE_DIRECTORY</code> argument.
If <code class="docutils literal notranslate">BASE_DIRECTORY</code> is not specified, the default base directory will be
<a class="reference internal" href="../variable/CMAKE_CURRENT_SOURCE_DIR.html#variable:CMAKE_CURRENT_SOURCE_DIR" title="CMAKE_CURRENT_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CURRENT_SOURCE_DIR</code></a>.
For reference, the algorithm used to compute the relative path is the same
as that used by C++
<a class="reference external" href="https://en.cppreference.com/w/cpp/filesystem/path/lexically_normal">std::filesystem::path::lexically_relative</a>.
<div class="highlight-cmake notranslate" id="absolute-path"><div class="highlight"><pre>cmake_path(ABSOLUTE_PATH &lt;path-var&gt; [BASE_DIRECTORY &lt;input&gt;] [NORMALIZE]
 [OUTPUT_VARIABLE &lt;out-var&gt;])
</pre></div>
</div>
If <code class="docutils literal notranslate">&lt;path-var&gt;</code> is a relative path (<a class="reference internal" href="#is-relative">IS_RELATIVE</a> is true), it is evaluated
relative to the given base directory specified by <code class="docutils literal notranslate">BASE_DIRECTORY</code> option.
If <code class="docutils literal notranslate">BASE_DIRECTORY</code> is not specified, the default base directory will be
<a class="reference internal" href="../variable/CMAKE_CURRENT_SOURCE_DIR.html#variable:CMAKE_CURRENT_SOURCE_DIR" title="CMAKE_CURRENT_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CURRENT_SOURCE_DIR</code></a>.
When the <code class="docutils literal notranslate">NORMALIZE</code> option is specified, the path is <a class="reference internal" href="#normalization">normalized</a> after the path computation.
Because <code class="docutils literal notranslate">cmake_path()</code> does not access the filesystem, symbolic links are
not resolved and any leading tilde is not expanded. To compute a real path
with symbolic links resolved and leading tildes expanded, use the
<a class="reference internal" href="file.html#command:file" title="file"><code class="xref cmake cmake-command docutils literal notranslate">file(REAL_PATH)</code></a> command instead.
</section>
<section id="native-conversion">
<h2>Native Conversion<a class="headerlink" href="#native-conversion" title="Permalink to this heading">¶</a></h2>
For commands in this section, native refers to the host platform, not the
target platform when cross-compiling.
<div class="highlight-cmake notranslate" id="native-path"><div class="highlight"><pre>cmake_path(NATIVE_PATH &lt;path-var&gt; [NORMALIZE] &lt;out-var&gt;)
</pre></div>
</div>
Converts a cmake-style <code class="docutils literal notranslate">&lt;path-var&gt;</code> into a native path with
platform-specific slashes (<code class="docutils literal notranslate">\</code> on Windows hosts and <code class="docutils literal notranslate">/</code> elsewhere).
When the <code class="docutils literal notranslate">NORMALIZE</code> option is specified, the path is <a class="reference internal" href="#normalization">normalized</a> before the conversion.
<div class="highlight-cmake notranslate" id="to-cmake-path-list"><div class="highlight"><pre>cmake_path(CONVERT &lt;input&gt; TO_CMAKE_PATH_LIST &lt;out-var&gt; [NORMALIZE])
</pre></div>
</div>
Converts a native <code class="docutils literal notranslate">&lt;input&gt;</code> path into a cmake-style path with forward
slashes (<code class="docutils literal notranslate">/</code>). On Windows hosts, the long filename marker is taken into
account. The input can be a single path or a system search path like
<code class="docutils literal notranslate">$ENV{PATH}</code>. A search path will be converted to a cmake-style list
separated by <code class="docutils literal notranslate">;</code> characters (on non-Windows platforms, this essentially
means <code class="docutils literal notranslate">:</code> separators are replaced with <code class="docutils literal notranslate">;</code>). The result of the
conversion is stored in the <code class="docutils literal notranslate">&lt;out-var&gt;</code> variable.
When the <code class="docutils literal notranslate">NORMALIZE</code> option is specified, the path is <a class="reference internal" href="#normalization">normalized</a> before the conversion.
<div class="admonition note">
Note
Unlike most other <code class="docutils literal notranslate">cmake_path()</code> subcommands, the <code class="docutils literal notranslate">CONVERT</code> subcommand
takes a literal string as input, not the name of a variable.
</div>
<div class="highlight-cmake notranslate" id="to-native-path-list"><div class="highlight"><pre>cmake_path(CONVERT &lt;input&gt; TO_NATIVE_PATH_LIST &lt;out-var&gt; [NORMALIZE])
</pre></div>
</div>
Converts a cmake-style <code class="docutils literal notranslate">&lt;input&gt;</code> path into a native path with
platform-specific slashes (<code class="docutils literal notranslate">\</code> on Windows hosts and <code class="docutils literal notranslate">/</code> elsewhere).
The input can be a single path or a cmake-style list. A list will be
converted into a native search path (<code class="docutils literal notranslate">;</code>-separated on Windows,
<code class="docutils literal notranslate">:</code>-separated on other platforms). The result of the conversion is
stored in the <code class="docutils literal notranslate">&lt;out-var&gt;</code> variable.
When the <code class="docutils literal notranslate">NORMALIZE</code> option is specified, the path is <a class="reference internal" href="#normalization">normalized</a> before the conversion.
<div class="admonition note">
Note
Unlike most other <code class="docutils literal notranslate">cmake_path()</code> subcommands, the <code class="docutils literal notranslate">CONVERT</code> subcommand
takes a literal string as input, not the name of a variable.
</div>
For example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(paths &quot;/a/b/c&quot; &quot;/x/y/z&quot;)
cmake_path(CONVERT &quot;${paths}&quot; TO_NATIVE_PATH_LIST native_paths)
message(&quot;Native path list is \&quot;${native_paths}\&quot;&quot;)
</pre></div>
</div>
Output on Windows:
<div class="highlight-none notranslate"><div class="highlight"><pre>Native path list is &quot;\a\b\c;\x\y\z&quot;
</pre></div>
</div>
Output on all other platforms:
<div class="highlight-none notranslate"><div class="highlight"><pre>Native path list is &quot;/a/b/c:/x/y/z&quot;
</pre></div>
</div>
</section>
<section id="hashing">
<h2>Hashing<a class="headerlink" href="#hashing" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="hash"><div class="highlight"><pre>cmake_path(HASH &lt;path-var&gt; &lt;out-var&gt;)
</pre></div>
</div>
Compute a hash value of <code class="docutils literal notranslate">&lt;path-var&gt;</code> such that for two paths <code class="docutils literal notranslate">p1</code> and
<code class="docutils literal notranslate">p2</code> that compare equal (<a class="reference internal" href="string.html#compare">COMPARE ... EQUAL</a>), the hash
value of <code class="docutils literal notranslate">p1</code> is equal to the hash value of <code class="docutils literal notranslate">p2</code>. The path is always
<a class="reference internal" href="#normalization">normalized</a> before the hash is computed.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">cmake_path</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#conventions">Conventions</a></li>
<li><a class="reference internal" href="#path-structure-and-terminology">Path Structure And Terminology</a></li>
<li><a class="reference internal" href="#creating-a-path-variable">Creating A Path Variable</a></li>
<li><a class="reference internal" href="#normalization">Normalization</a></li>
<li><a class="reference internal" href="#decomposition">Decomposition</a><ul>
<li><a class="reference internal" href="#root-examples">Root examples</a></li>
<li><a class="reference internal" href="#filename-examples">Filename examples</a></li>
<li><a class="reference internal" href="#extension-and-stem-examples">Extension and stem examples</a></li>
<li><a class="reference internal" href="#relative-part-examples">Relative part examples</a></li>
<li><a class="reference internal" href="#path-traversal-examples">Path traversal examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#query">Query</a></li>
<li><a class="reference internal" href="#modification">Modification</a></li>
<li><a class="reference internal" href="#generation">Generation</a></li>
<li><a class="reference internal" href="#native-conversion">Native Conversion</a></li>
<li><a class="reference internal" href="#hashing">Hashing</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="cmake_parse_arguments.html"
 title="previous chapter">cmake_parse_arguments</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="cmake_policy.html"
 title="next chapter">cmake_policy</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/command/cmake_path.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="cmake_policy.html" title="cmake_policy"
 >next</a> |</li>
 <li class="right" >
 <a href="cmake_parse_arguments.html" title="cmake_parse_arguments"
 >previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">cmake_path</a></li> 
 </ul>
 </div>

<div class="footer" role="contentinfo">
 &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
 </div>
 </body>
</html>