| <!DOCTYPE html> | |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> | |
| <head> | |
| <meta charset="utf-8" /> | |
| <title>UNITY_BUILD_UNIQUE_ID — CMake 3.23.1 Documentation</title> | |
| <link rel="stylesheet" href="../_static/cmake.css" type="text/css" /> | |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| <script type="text/javascript" src="../_static/jquery.js"></script> | |
| <script type="text/javascript" src="../_static/underscore.js"></script> | |
| <script type="text/javascript" src="../_static/doctools.js"></script> | |
| <script type="text/javascript" src="../_static/language_data.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="VERSION" href="VERSION.html" /> | |
| <link rel="prev" title="UNITY_BUILD_MODE" href="UNITY_BUILD_MODE.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="VERSION.html" title="VERSION" | |
| accesskey="N">next</a> |</li> | |
| <li class="right" > | |
| <a href="UNITY_BUILD_MODE.html" title="UNITY_BUILD_MODE" | |
| 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> » | |
| </li> | |
| <li> | |
| <a href="../index.html">3.23.1 Documentation</a> » | |
| </li> | |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" accesskey="U">cmake-properties(7)</a> »</li> | |
| </ul> | |
| </div> | |
| <div class="document"> | |
| <div class="documentwrapper"> | |
| <div class="bodywrapper"> | |
| <div class="body" role="main"> | |
| <div class="section" id="unity-build-unique-id"> | |
| <span id="prop_tgt:UNITY_BUILD_UNIQUE_ID"></span><h1>UNITY_BUILD_UNIQUE_ID<a class="headerlink" href="#unity-build-unique-id" title="Permalink to this headline">ΒΆ</a></h1> | |
| <div class="versionadded"> | |
| <p><span class="versionmodified added">New in version 3.20.</span></p> | |
| </div> | |
| <p>The name of a valid C-identifier which is set to a unique per-file | |
| value during unity builds.</p> | |
| <p>When this property is populated and when <span class="target" id="index-0-prop_tgt:UNITY_BUILD"></span><a class="reference internal" href="UNITY_BUILD.html#prop_tgt:UNITY_BUILD" title="UNITY_BUILD"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">UNITY_BUILD</span></code></a> | |
| is true, the property value is used to define a compiler definition | |
| of the specified name. The value of the defined symbol is unspecified, | |
| but it is unique per file path.</p> | |
| <p>Given:</p> | |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">set_target_properties(</span><span class="nb">myTarget</span><span class="w"> </span><span class="no">PROPERTIES</span><span class="w"></span> | |
| <span class="w"> </span><span class="no">UNITY_BUILD</span><span class="w"> </span><span class="s">"ON"</span><span class="w"></span> | |
| <span class="w"> </span><span class="no">UNITY_BUILD_UNIQUE_ID</span><span class="w"> </span><span class="s">"MY_UNITY_ID"</span><span class="w"></span> | |
| <span class="nf">)</span><span class="w"></span> | |
| </pre></div> | |
| </div> | |
| <p>the <code class="docutils literal notranslate"><span class="pre">MY_UNITY_ID</span></code> symbol is defined to a unique per-file value.</p> | |
| <p>One known use case for this identifier is to disambiguate the | |
| variables in an anonymous namespace in a limited scope. | |
| Anonymous namespaces present a problem for unity builds because | |
| they are used to ensure that certain variables and declarations | |
| are scoped to a translation unit which is approximated by a | |
| single source file. When source files are combined in a unity | |
| build file, those variables in different files are combined in | |
| a single translation unit and the names clash. This property can | |
| be used to avoid that with code like the following:</p> | |
| <div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="c1">// Needed for when unity builds are disabled</span> | |
| <span class="cp">#ifndef MY_UNITY_ID</span> | |
| <span class="cp">#define MY_UNITY_ID</span> | |
| <span class="cp">#endif</span> | |
| <span class="k">namespace</span> <span class="p">{</span> <span class="k">namespace</span> <span class="n">MY_UNITY_ID</span> <span class="p">{</span> | |
| <span class="c1">// The name 'i' clashes (or could clash) with other</span> | |
| <span class="c1">// variables in other anonymous namespaces</span> | |
| <span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">42</span><span class="p">;</span> | |
| <span class="p">}}</span> | |
| <span class="kt">int</span> <span class="n">use_var</span><span class="p">()</span> | |
| <span class="p">{</span> | |
| <span class="k">return</span> <span class="n">MY_UNITY_ID</span><span class="o">::</span><span class="n">i</span><span class="p">;</span> | |
| <span class="p">}</span> | |
| </pre></div> | |
| </div> | |
| <p>The pseudonymous namespace is used within a truly anonymous namespace. | |
| On many platforms, this maintains the invariant that the symbols within | |
| do not get external linkage when performing a unity build.</p> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| <div class="sphinxsidebarwrapper"> | |
| <h4>Previous topic</h4> | |
| <p class="topless"><a href="UNITY_BUILD_MODE.html" | |
| title="previous chapter">UNITY_BUILD_MODE</a></p> | |
| <h4>Next topic</h4> | |
| <p class="topless"><a href="VERSION.html" | |
| title="next chapter">VERSION</a></p> | |
| <div role="note" aria-label="source link"> | |
| <h3>This Page</h3> | |
| <ul class="this-page-menu"> | |
| <li><a href="../_sources/prop_tgt/UNITY_BUILD_UNIQUE_ID.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" /> | |
| <input type="submit" value="Go" /> | |
| </form> | |
| </div> | |
| </div> | |
| <script type="text/javascript">$('#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="VERSION.html" title="VERSION" | |
| >next</a> |</li> | |
| <li class="right" > | |
| <a href="UNITY_BUILD_MODE.html" title="UNITY_BUILD_MODE" | |
| >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> » | |
| </li> | |
| <li> | |
| <a href="../index.html">3.23.1 Documentation</a> » | |
| </li> | |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" >cmake-properties(7)</a> »</li> | |
| </ul> | |
| </div> | |
| <div class="footer" role="contentinfo"> | |
| © Copyright 2000-2022 Kitware, Inc. and Contributors. | |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2. | |
| </div> | |
| </body> | |
| </html> |