blob: dd684149563084b7fc0ec061d17ef0b26cd247a6 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AUTOMOC_PATH_PREFIX &mdash; CMake 3.23.1 Documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/cmake.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/cmake-favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="AUTORCC" href="AUTORCC.html" />
<link rel="prev" title="AUTOMOC_MOC_OPTIONS" href="AUTOMOC_MOC_OPTIONS.html" />
</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="AUTORCC.html" title="AUTORCC"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="AUTOMOC_MOC_OPTIONS.html" title="AUTOMOC_MOC_OPTIONS"
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.23.1 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" accesskey="U">cmake-properties(7)</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">AUTOMOC_PATH_PREFIX</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="automoc-path-prefix">
<span id="prop_tgt:AUTOMOC_PATH_PREFIX"></span><h1>AUTOMOC_PATH_PREFIX<a class="headerlink" href="#automoc-path-prefix" title="Permalink to this headline"></a></h1>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.16.</span></p>
</div>
<p>When this property is <code class="docutils literal notranslate"><span class="pre">ON</span></code>, CMake will generate the <code class="docutils literal notranslate"><span class="pre">-p</span></code> path prefix
option for <code class="docutils literal notranslate"><span class="pre">moc</span></code> on <span class="target" id="index-0-prop_tgt:AUTOMOC"></span><a class="reference internal" href="AUTOMOC.html#prop_tgt:AUTOMOC" title="AUTOMOC"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">AUTOMOC</span></code></a> enabled Qt targets.</p>
<p>To generate the path prefix, CMake tests if the header compiled by <code class="docutils literal notranslate"><span class="pre">moc</span></code>
is in any of the target
<span class="target" id="index-0-command:target_include_directories"></span><a class="reference internal" href="../command/target_include_directories.html#command:target_include_directories" title="target_include_directories"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">include</span> <span class="pre">directories</span></code></a>. If so, CMake will
compute the relative path accordingly. If the header is not in the
<span class="target" id="index-1-command:target_include_directories"></span><a class="reference internal" href="../command/target_include_directories.html#command:target_include_directories" title="target_include_directories"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">include</span> <span class="pre">directories</span></code></a>, CMake will omit
the <code class="docutils literal notranslate"><span class="pre">-p</span></code> path prefix option. <code class="docutils literal notranslate"><span class="pre">moc</span></code> usually generates a
relative include path in that case.</p>
<p><span class="target" id="index-0-prop_tgt:AUTOMOC_PATH_PREFIX"></span><a class="reference internal" href="#prop_tgt:AUTOMOC_PATH_PREFIX" title="AUTOMOC_PATH_PREFIX"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">AUTOMOC_PATH_PREFIX</span></code></a> is initialized from the variable
<span class="target" id="index-0-variable:CMAKE_AUTOMOC_PATH_PREFIX"></span><a class="reference internal" href="../variable/CMAKE_AUTOMOC_PATH_PREFIX.html#variable:CMAKE_AUTOMOC_PATH_PREFIX" title="CMAKE_AUTOMOC_PATH_PREFIX"><code class="xref cmake cmake-variable docutils literal notranslate"><span class="pre">CMAKE_AUTOMOC_PATH_PREFIX</span></code></a>, which is <code class="docutils literal notranslate"><span class="pre">OFF</span></code> by default.</p>
<p>See the <span class="target" id="index-0-manual:cmake-qt(7)"></span><a class="reference internal" href="../manual/cmake-qt.7.html#manual:cmake-qt(7)" title="cmake-qt(7)"><code class="xref cmake cmake-manual docutils literal notranslate"><span class="pre">cmake-qt(7)</span></code></a> manual for more information on using CMake
with Qt.</p>
<div class="section" id="reproducible-builds">
<h2>Reproducible builds<a class="headerlink" href="#reproducible-builds" title="Permalink to this headline"></a></h2>
<p>For reproducible builds it is recommended to keep headers that are <code class="docutils literal notranslate"><span class="pre">moc</span></code>
compiled in one of the target
<span class="target" id="index-2-command:target_include_directories"></span><a class="reference internal" href="../command/target_include_directories.html#command:target_include_directories" title="target_include_directories"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">include</span> <span class="pre">directories</span></code></a> and set
<span class="target" id="index-1-prop_tgt:AUTOMOC_PATH_PREFIX"></span><a class="reference internal" href="#prop_tgt:AUTOMOC_PATH_PREFIX" title="AUTOMOC_PATH_PREFIX"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">AUTOMOC_PATH_PREFIX</span></code></a> to <code class="docutils literal notranslate"><span class="pre">ON</span></code>. This ensures that:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">moc</span></code> output files are identical on different build setups,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">moc</span></code> output files will compile correctly when the source and/or
build directory is a symbolic link.</p></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">AUTOMOC_PATH_PREFIX</a><ul>
<li><a class="reference internal" href="#reproducible-builds">Reproducible builds</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="AUTOMOC_MOC_OPTIONS.html"
title="previous chapter">AUTOMOC_MOC_OPTIONS</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="AUTORCC.html"
title="next chapter">AUTORCC</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/prop_tgt/AUTOMOC_PATH_PREFIX.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>$('#searchbox').show(0);</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="AUTORCC.html" title="AUTORCC"
>next</a> |</li>
<li class="right" >
<a href="AUTOMOC_MOC_OPTIONS.html" title="AUTOMOC_MOC_OPTIONS"
>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.23.1 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" >cmake-properties(7)</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">AUTOMOC_PATH_PREFIX</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2000-2022 Kitware, Inc. and Contributors.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
</div>
</body>
</html>