| |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>FindPackageHandleStandardArgs — 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="FindPackageMessage" href="FindPackageMessage.html" /> |
| <link rel="prev" title="FetchContent" href="FetchContent.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="FindPackageMessage.html" title="FindPackageMessage" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="FetchContent.html" title="FetchContent" |
| 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-modules.7.html" accesskey="U">cmake-modules(7)</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">FindPackageHandleStandardArgs</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="findpackagehandlestandardargs"> |
| <span id="module:FindPackageHandleStandardArgs"></span><h1>FindPackageHandleStandardArgs<a class="headerlink" href="#findpackagehandlestandardargs" title="Permalink to this headline">¶</a></h1> |
| <p>This module provides functions intended to be used in <a class="reference internal" href="../manual/cmake-developer.7.html#find-modules"><span class="std std-ref">Find Modules</span></a> |
| implementing <span class="target" id="index-0-command:find_package"></span><a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">find_package(<PackageName>)</span></code></a> calls.</p> |
| <dl class="cmake command"> |
| <dt class="sig sig-object cmake" id="command:find_package_handle_standard_args"> |
| <span class="sig-name descname"><span class="pre">find_package_handle_standard_args</span></span><a class="headerlink" href="#command:find_package_handle_standard_args" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This command handles the <code class="docutils literal notranslate"><span class="pre">REQUIRED</span></code>, <code class="docutils literal notranslate"><span class="pre">QUIET</span></code> and version-related |
| arguments of <span class="target" id="index-1-command:find_package"></span><a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">find_package()</span></code></a>. It also sets the |
| <code class="docutils literal notranslate"><span class="pre"><PackageName>_FOUND</span></code> variable. The package is considered found if all |
| variables listed contain valid results, e.g. valid filepaths.</p> |
| <p>There are two signatures:</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package_handle_standard_args(</span><span class="nv"><PackageName></span><span class="w"></span> |
| <span class="w"> </span><span class="nf">(</span><span class="no">DEFAULT_MSG</span><span class="p">|</span><span class="nv"><custom-failure-message></span><span class="nf">)</span><span class="w"></span> |
| <span class="w"> </span><span class="nv"><required-var>...</span><span class="w"></span> |
| <span class="w"> </span><span class="nf">)</span><span class="w"></span> |
| |
| <span class="nf">find_package_handle_standard_args(</span><span class="nv"><PackageName></span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">FOUND_VAR</span><span class="w"> </span><span class="nv"><result-var></span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">REQUIRED_VARS</span><span class="w"> </span><span class="nv"><required-var>...</span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">VERSION_VAR</span><span class="w"> </span><span class="nv"><version-var></span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">HANDLE_VERSION_RANGE</span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">HANDLE_COMPONENTS</span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">CONFIG_MODE</span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">NAME_MISMATCHED</span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">REASON_FAILURE_MESSAGE</span><span class="w"> </span><span class="nv"><reason-failure-message></span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">FAIL_MESSAGE</span><span class="w"> </span><span class="nv"><custom-failure-message></span><span class="p">]</span><span class="w"></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"><PackageName>_FOUND</span></code> variable will be set to <code class="docutils literal notranslate"><span class="pre">TRUE</span></code> if all |
| the variables <code class="docutils literal notranslate"><span class="pre"><required-var>...</span></code> are valid and any optional |
| constraints are satisfied, and <code class="docutils literal notranslate"><span class="pre">FALSE</span></code> otherwise. A success or |
| failure message may be displayed based on the results and on |
| whether the <code class="docutils literal notranslate"><span class="pre">REQUIRED</span></code> and/or <code class="docutils literal notranslate"><span class="pre">QUIET</span></code> option was given to |
| the <span class="target" id="index-2-command:find_package"></span><a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">find_package()</span></code></a> call.</p> |
| <p>The options are:</p> |
| <dl> |
| <dt><code class="docutils literal notranslate"><span class="pre">(DEFAULT_MSG|<custom-failure-message>)</span></code></dt><dd><p>In the simple signature this specifies the failure message. |
| Use <code class="docutils literal notranslate"><span class="pre">DEFAULT_MSG</span></code> to ask for a default message to be computed |
| (recommended). Not valid in the full signature.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">FOUND_VAR</span> <span class="pre"><result-var></span></code></dt><dd><div class="deprecated"> |
| <p><span class="versionmodified deprecated">Deprecated since version 3.3.</span></p> |
| </div> |
| <p>Specifies either <code class="docutils literal notranslate"><span class="pre"><PackageName>_FOUND</span></code> or |
| <code class="docutils literal notranslate"><span class="pre"><PACKAGENAME>_FOUND</span></code> as the result variable. This exists only |
| for compatibility with older versions of CMake and is now ignored. |
| Result variables of both names are always set for compatibility.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">REQUIRED_VARS</span> <span class="pre"><required-var>...</span></code></dt><dd><p>Specify the variables which are required for this package. |
| These may be named in the generated failure message asking the |
| user to set the missing variable values. Therefore these should |
| typically be cache entries such as <code class="docutils literal notranslate"><span class="pre">FOO_LIBRARY</span></code> and not output |
| variables like <code class="docutils literal notranslate"><span class="pre">FOO_LIBRARIES</span></code>.</p> |
| <div class="versionchanged"> |
| <p><span class="versionmodified changed">Changed in version 3.18: </span>If <code class="docutils literal notranslate"><span class="pre">HANDLE_COMPONENTS</span></code> is specified, this option can be omitted.</p> |
| </div> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">VERSION_VAR</span> <span class="pre"><version-var></span></code></dt><dd><p>Specify the name of a variable that holds the version of the package |
| that has been found. This version will be checked against the |
| (potentially) specified required version given to the |
| <span class="target" id="index-3-command:find_package"></span><a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">find_package()</span></code></a> call, including its <code class="docutils literal notranslate"><span class="pre">EXACT</span></code> option. |
| The default messages include information about the required |
| version and the version which has been actually found, both |
| if the version is ok or not.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">HANDLE_VERSION_RANGE</span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.19.</span></p> |
| </div> |
| <p>Enable handling of a version range, if one is specified. Without this |
| option, a developer warning will be displayed if a version range is |
| specified.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">HANDLE_COMPONENTS</span></code></dt><dd><p>Enable handling of package components. In this case, the command |
| will report which components have been found and which are missing, |
| and the <code class="docutils literal notranslate"><span class="pre"><PackageName>_FOUND</span></code> variable will be set to <code class="docutils literal notranslate"><span class="pre">FALSE</span></code> |
| if any of the required components (i.e. not the ones listed after |
| the <code class="docutils literal notranslate"><span class="pre">OPTIONAL_COMPONENTS</span></code> option of <span class="target" id="index-4-command:find_package"></span><a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">find_package()</span></code></a>) are |
| missing.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CONFIG_MODE</span></code></dt><dd><p>Specify that the calling find module is a wrapper around a |
| call to <code class="docutils literal notranslate"><span class="pre">find_package(<PackageName></span> <span class="pre">NO_MODULE)</span></code>. This implies |
| a <code class="docutils literal notranslate"><span class="pre">VERSION_VAR</span></code> value of <code class="docutils literal notranslate"><span class="pre"><PackageName>_VERSION</span></code>. The command |
| will automatically check whether the package configuration file |
| was found.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">REASON_FAILURE_MESSAGE</span> <span class="pre"><reason-failure-message></span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.16.</span></p> |
| </div> |
| <p>Specify a custom message of the reason for the failure which will be |
| appended to the default generated message.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">FAIL_MESSAGE</span> <span class="pre"><custom-failure-message></span></code></dt><dd><p>Specify a custom failure message instead of using the default |
| generated message. Not recommended.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">NAME_MISMATCHED</span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.17.</span></p> |
| </div> |
| <p>Indicate that the <code class="docutils literal notranslate"><span class="pre"><PackageName></span></code> does not match |
| <code class="docutils literal notranslate"><span class="pre">${CMAKE_FIND_PACKAGE_NAME}</span></code>. This is usually a mistake and raises a |
| warning, but it may be intentional for usage of the command for components |
| of a larger package.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <p>Example for the simple signature:</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package_handle_standard_args(</span><span class="nb">LibXml2</span><span class="w"> </span><span class="no">DEFAULT_MSG</span><span class="w"></span> |
| <span class="w"> </span><span class="no">LIBXML2_LIBRARY</span><span class="w"> </span><span class="no">LIBXML2_INCLUDE_DIR</span><span class="nf">)</span><span class="w"></span> |
| </pre></div> |
| </div> |
| <p>The <code class="docutils literal notranslate"><span class="pre">LibXml2</span></code> package is considered to be found if both |
| <code class="docutils literal notranslate"><span class="pre">LIBXML2_LIBRARY</span></code> and <code class="docutils literal notranslate"><span class="pre">LIBXML2_INCLUDE_DIR</span></code> are valid. |
| Then also <code class="docutils literal notranslate"><span class="pre">LibXml2_FOUND</span></code> is set to <code class="docutils literal notranslate"><span class="pre">TRUE</span></code>. If it is not found |
| and <code class="docutils literal notranslate"><span class="pre">REQUIRED</span></code> was used, it fails with a |
| <span class="target" id="index-0-command:message"></span><a class="reference internal" href="../command/message.html#command:message" title="message"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">message(FATAL_ERROR)</span></code></a>, independent whether <code class="docutils literal notranslate"><span class="pre">QUIET</span></code> was |
| used or not. If it is found, success will be reported, including |
| the content of the first <code class="docutils literal notranslate"><span class="pre"><required-var></span></code>. On repeated CMake runs, |
| the same message will not be printed again.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>If <code class="docutils literal notranslate"><span class="pre"><PackageName></span></code> does not match <code class="docutils literal notranslate"><span class="pre">CMAKE_FIND_PACKAGE_NAME</span></code> for the |
| calling module, a warning that there is a mismatch is given. The |
| <code class="docutils literal notranslate"><span class="pre">FPHSA_NAME_MISMATCHED</span></code> variable may be set to bypass the warning if using |
| the old signature and the <code class="docutils literal notranslate"><span class="pre">NAME_MISMATCHED</span></code> argument using the new |
| signature. To avoid forcing the caller to require newer versions of CMake for |
| usage, the variable's value will be used if defined when the |
| <code class="docutils literal notranslate"><span class="pre">NAME_MISMATCHED</span></code> argument is not passed for the new signature (but using |
| both is an error)..</p> |
| </div> |
| <p>Example for the full signature:</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package_handle_standard_args(</span><span class="nb">LibArchive</span><span class="w"></span> |
| <span class="w"> </span><span class="no">REQUIRED_VARS</span><span class="w"> </span><span class="nb">LibArchive_LIBRARY</span><span class="w"> </span><span class="nb">LibArchive_INCLUDE_DIR</span><span class="w"></span> |
| <span class="w"> </span><span class="no">VERSION_VAR</span><span class="w"> </span><span class="nb">LibArchive_VERSION</span><span class="nf">)</span><span class="w"></span> |
| </pre></div> |
| </div> |
| <p>In this case, the <code class="docutils literal notranslate"><span class="pre">LibArchive</span></code> package is considered to be found if |
| both <code class="docutils literal notranslate"><span class="pre">LibArchive_LIBRARY</span></code> and <code class="docutils literal notranslate"><span class="pre">LibArchive_INCLUDE_DIR</span></code> are valid. |
| Also the version of <code class="docutils literal notranslate"><span class="pre">LibArchive</span></code> will be checked by using the version |
| contained in <code class="docutils literal notranslate"><span class="pre">LibArchive_VERSION</span></code>. Since no <code class="docutils literal notranslate"><span class="pre">FAIL_MESSAGE</span></code> is given, |
| the default messages will be printed.</p> |
| <p>Another example for the full signature:</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package(</span><span class="nb">Automoc4</span><span class="w"> </span><span class="no">QUIET</span><span class="w"> </span><span class="no">NO_MODULE</span><span class="w"> </span><span class="no">HINTS</span><span class="w"> </span><span class="na">/opt/automoc4</span><span class="nf">)</span><span class="w"></span> |
| <span class="nf">find_package_handle_standard_args(</span><span class="nb">Automoc4</span><span class="w"> </span><span class="no">CONFIG_MODE</span><span class="nf">)</span><span class="w"></span> |
| </pre></div> |
| </div> |
| <p>In this case, a <code class="docutils literal notranslate"><span class="pre">FindAutmoc4.cmake</span></code> module wraps a call to |
| <code class="docutils literal notranslate"><span class="pre">find_package(Automoc4</span> <span class="pre">NO_MODULE)</span></code> and adds an additional search |
| directory for <code class="docutils literal notranslate"><span class="pre">automoc4</span></code>. Then the call to |
| <code class="docutils literal notranslate"><span class="pre">find_package_handle_standard_args</span></code> produces a proper success/failure |
| message.</p> |
| <dl class="cmake command"> |
| <dt class="sig sig-object cmake" id="command:find_package_check_version"> |
| <span class="sig-name descname"><span class="pre">find_package_check_version</span></span><a class="headerlink" href="#command:find_package_check_version" title="Permalink to this definition">¶</a></dt> |
| <dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.19.</span></p> |
| </div> |
| <p>Helper function which can be used to check if a <code class="docutils literal notranslate"><span class="pre"><version></span></code> is valid |
| against version-related arguments of <span class="target" id="index-5-command:find_package"></span><a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">find_package()</span></code></a>.</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package_check_version(</span><span class="nv"><version></span><span class="w"> </span><span class="nv"><result-var></span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">HANDLE_VERSION_RANGE</span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">RESULT_MESSAGE_VARIABLE</span><span class="w"> </span><span class="nv"><message-var></span><span class="p">]</span><span class="w"></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"><result-var></span></code> will hold a boolean value giving the result of the check.</p> |
| <p>The options are:</p> |
| <dl class="simple"> |
| <dt><code class="docutils literal notranslate"><span class="pre">HANDLE_VERSION_RANGE</span></code></dt><dd><p>Enable handling of a version range, if one is specified. Without this |
| option, a developer warning will be displayed if a version range is |
| specified.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">RESULT_MESSAGE_VARIABLE</span> <span class="pre"><message-var></span></code></dt><dd><p>Specify a variable to get back a message describing the result of the check.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <p>Example for the usage:</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package_check_version(</span><span class="m">1.2.3</span><span class="w"> </span><span class="nb">result</span><span class="w"> </span><span class="no">HANDLE_VERSION_RANGE</span><span class="w"></span> |
| <span class="w"> </span><span class="no">RESULT_MESSAGE_VARIABLE</span><span class="w"> </span><span class="nb">reason</span><span class="nf">)</span><span class="w"></span> |
| <span class="nf">if</span> <span class="nf">(</span><span class="nb">result</span><span class="nf">)</span><span class="w"></span> |
| <span class="w"> </span><span class="nf">message</span> <span class="nf">(</span><span class="no">STATUS</span><span class="w"> </span><span class="s">"${reason}"</span><span class="nf">)</span><span class="w"></span> |
| <span class="nf">else()</span><span class="w"></span> |
| <span class="w"> </span><span class="nf">message</span> <span class="nf">(</span><span class="no">FATAL_ERROR</span><span class="w"> </span><span class="s">"${reason}"</span><span class="nf">)</span><span class="w"></span> |
| <span class="nf">endif()</span><span class="w"></span> |
| </pre></div> |
| </div> |
| </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="FetchContent.html" |
| title="previous chapter">FetchContent</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="FindPackageMessage.html" |
| title="next chapter">FindPackageMessage</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/module/FindPackageHandleStandardArgs.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="FindPackageMessage.html" title="FindPackageMessage" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="FetchContent.html" title="FetchContent" |
| >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-modules.7.html" >cmake-modules(7)</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">FindPackageHandleStandardArgs</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> |
