| |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>COMPILE_DEFINITIONS — 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="COMPILE_FEATURES" href="COMPILE_FEATURES.html" /> |
| <link rel="prev" title="COMPATIBLE_INTERFACE_STRING" href="COMPATIBLE_INTERFACE_STRING.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="COMPILE_FEATURES.html" title="COMPILE_FEATURES" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="COMPATIBLE_INTERFACE_STRING.html" title="COMPATIBLE_INTERFACE_STRING" |
| 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> |
| <li class="nav-item nav-item-this"><a href="">COMPILE_DEFINITIONS</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="compile-definitions"> |
| <span id="prop_tgt:COMPILE_DEFINITIONS"></span><h1>COMPILE_DEFINITIONS<a class="headerlink" href="#compile-definitions" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>Preprocessor definitions for compiling a target's sources.</p> |
| <p>The <code class="docutils literal notranslate"><span class="pre">COMPILE_DEFINITIONS</span></code> property may be set to a semicolon-separated |
| list of preprocessor definitions using the syntax <code class="docutils literal notranslate"><span class="pre">VAR</span></code> or <code class="docutils literal notranslate"><span class="pre">VAR=value</span></code>. |
| Function-style definitions are not supported. CMake will |
| automatically escape the value correctly for the native build system |
| (note that CMake language syntax may require escapes to specify some |
| values).</p> |
| <p>CMake will automatically drop some definitions that are not supported |
| by the native build tool.</p> |
| <p>Disclaimer: Most native build tools have poor support for escaping |
| certain values. CMake has work-arounds for many cases but some values |
| may just not be possible to pass correctly. If a value does not seem |
| to be escaped correctly, do not attempt to work-around the problem by |
| adding escape sequences to the value. Your work-around may break in a |
| future version of CMake that has improved escape support. Instead |
| consider defining the macro in a (configured) header file. Then |
| report the limitation. Known limitations include:</p> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span># - broken almost everywhere |
| ; - broken in VS IDE 7.0 and Borland Makefiles |
| , - broken in VS IDE |
| % - broken in some cases in NMake |
| & | - broken in some cases on MinGW |
| ^ < > \" - broken in most Make tools on Windows |
| </pre></div> |
| </div> |
| <p>CMake does not reject these values outright because they do work in |
| some cases. Use with caution.</p> |
| <p>Contents of <code class="docutils literal notranslate"><span class="pre">COMPILE_DEFINITIONS</span></code> may use "generator expressions" with the |
| syntax <code class="docutils literal notranslate"><span class="pre">$<...></span></code>. See the <span class="target" id="index-0-manual:cmake-generator-expressions(7)"></span><a class="reference internal" href="../manual/cmake-generator-expressions.7.html#manual:cmake-generator-expressions(7)" title="cmake-generator-expressions(7)"><code class="xref cmake cmake-manual docutils literal notranslate"><span class="pre">cmake-generator-expressions(7)</span></code></a> manual |
| for available expressions. See the <span class="target" id="index-0-manual:cmake-buildsystem(7)"></span><a class="reference internal" href="../manual/cmake-buildsystem.7.html#manual:cmake-buildsystem(7)" title="cmake-buildsystem(7)"><code class="xref cmake cmake-manual docutils literal notranslate"><span class="pre">cmake-buildsystem(7)</span></code></a> manual |
| for more on defining buildsystem properties.</p> |
| <p>The corresponding <span class="target" id="index-0-prop_tgt:COMPILE_DEFINITIONS_<CONFIG>"></span><a class="reference internal" href="COMPILE_DEFINITIONS_CONFIG.html#prop_tgt:COMPILE_DEFINITIONS_<CONFIG>" title="COMPILE_DEFINITIONS_<CONFIG>"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">COMPILE_DEFINITIONS_<CONFIG></span></code></a> property may |
| be set to specify per-configuration definitions. Generator expressions |
| should be preferred instead of setting the alternative property.</p> |
| </div> |
| |
| |
| <div class="clearer"></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="COMPATIBLE_INTERFACE_STRING.html" |
| title="previous chapter">COMPATIBLE_INTERFACE_STRING</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="COMPILE_FEATURES.html" |
| title="next chapter">COMPILE_FEATURES</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/prop_tgt/COMPILE_DEFINITIONS.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="COMPILE_FEATURES.html" title="COMPILE_FEATURES" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="COMPATIBLE_INTERFACE_STRING.html" title="COMPATIBLE_INTERFACE_STRING" |
| >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> |
| <li class="nav-item nav-item-this"><a href="">COMPILE_DEFINITIONS</a></li> |
| </ul> |
| </div> |
| |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2022 Kitware, Inc. and Contributors. |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2. |
| </div> |
| </body> |
| </html> |