| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>GetPrerequisites — CMake 3.8.2 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"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '../', |
| VERSION: '3.8.2', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </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> |
| <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="GNUInstallDirs" href="GNUInstallDirs.html" /> |
| <link rel="prev" title="GenerateExportHeader" href="GenerateExportHeader.html" /> |
| </head> |
| <body role="document"> |
| <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="GNUInstallDirs.html" title="GNUInstallDirs" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="GenerateExportHeader.html" title="GenerateExportHeader" |
| 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.8.2 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" accesskey="U">cmake-modules(7)</a> »</li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="getprerequisites"> |
| <span id="module:GetPrerequisites"></span><h1>GetPrerequisites<a class="headerlink" href="#getprerequisites" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>Functions to analyze and list executable file prerequisites.</p> |
| <p>This module provides functions to list the .dll, .dylib or .so files |
| that an executable or shared library file depends on. (Its |
| prerequisites.)</p> |
| <p>It uses various tools to obtain the list of required shared library |
| files:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">dumpbin</span> <span class="p">(</span><span class="n">Windows</span><span class="p">)</span> |
| <span class="n">objdump</span> <span class="p">(</span><span class="n">MinGW</span> <span class="n">on</span> <span class="n">Windows</span><span class="p">)</span> |
| <span class="n">ldd</span> <span class="p">(</span><span class="n">Linux</span><span class="o">/</span><span class="n">Unix</span><span class="p">)</span> |
| <span class="n">otool</span> <span class="p">(</span><span class="n">Mac</span> <span class="n">OSX</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>The following functions are provided by this module:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">get_prerequisites</span> |
| <span class="n">list_prerequisites</span> |
| <span class="n">list_prerequisites_by_glob</span> |
| <span class="n">gp_append_unique</span> |
| <span class="n">is_file_executable</span> |
| <span class="n">gp_item_default_embedded_path</span> |
| <span class="p">(</span><span class="n">projects</span> <span class="n">can</span> <span class="n">override</span> <span class="k">with</span> <span class="n">gp_item_default_embedded_path_override</span><span class="p">)</span> |
| <span class="n">gp_resolve_item</span> |
| <span class="p">(</span><span class="n">projects</span> <span class="n">can</span> <span class="n">override</span> <span class="k">with</span> <span class="n">gp_resolve_item_override</span><span class="p">)</span> |
| <span class="n">gp_resolved_file_type</span> |
| <span class="p">(</span><span class="n">projects</span> <span class="n">can</span> <span class="n">override</span> <span class="k">with</span> <span class="n">gp_resolved_file_type_override</span><span class="p">)</span> |
| <span class="n">gp_file_type</span> |
| </pre></div> |
| </div> |
| <p>Requires CMake 2.6 or greater because it uses function, break, return |
| and PARENT_SCOPE.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET_PREREQUISITES</span><span class="p">(</span><span class="o"><</span><span class="n">target</span><span class="o">></span> <span class="o"><</span><span class="n">prerequisites_var</span><span class="o">></span> <span class="o"><</span><span class="n">exclude_system</span><span class="o">></span> <span class="o"><</span><span class="n">recurse</span><span class="o">></span> |
| <span class="o"><</span><span class="n">exepath</span><span class="o">></span> <span class="o"><</span><span class="n">dirs</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">rpaths</span><span class="o">></span><span class="p">])</span> |
| </pre></div> |
| </div> |
| <p>Get the list of shared library files required by <target>. The list |
| in the variable named <prerequisites_var> should be empty on first |
| entry to this function. On exit, <prerequisites_var> will contain the |
| list of required shared library files.</p> |
| <p><target> is the full path to an executable file. <prerequisites_var> |
| is the name of a CMake variable to contain the results. |
| <exclude_system> must be 0 or 1 indicating whether to include or |
| exclude “system” prerequisites. If <recurse> is set to 1 all |
| prerequisites will be found recursively, if set to 0 only direct |
| prerequisites are listed. <exepath> is the path to the top level |
| executable used for @executable_path replacment on the Mac. <dirs> is |
| a list of paths where libraries might be found: these paths are |
| searched first when a target without any path info is given. Then |
| standard system locations are also searched: PATH, Framework |
| locations, /usr/lib...</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">LIST_PREREQUISITES</span><span class="p">(</span><span class="o"><</span><span class="n">target</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">recurse</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">exclude_system</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">verbose</span><span class="o">></span><span class="p">]]])</span> |
| </pre></div> |
| </div> |
| <p>Print a message listing the prerequisites of <target>.</p> |
| <p><target> is the name of a shared library or executable target or the |
| full path to a shared library or executable file. If <recurse> is set |
| to 1 all prerequisites will be found recursively, if set to 0 only |
| direct prerequisites are listed. <exclude_system> must be 0 or 1 |
| indicating whether to include or exclude “system” prerequisites. With |
| <verbose> set to 0 only the full path names of the prerequisites are |
| printed, set to 1 extra informatin will be displayed.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">LIST_PREREQUISITES_BY_GLOB</span><span class="p">(</span><span class="o"><</span><span class="n">glob_arg</span><span class="o">></span> <span class="o"><</span><span class="n">glob_exp</span><span class="o">></span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Print the prerequisites of shared library and executable files |
| matching a globbing pattern. <glob_arg> is GLOB or GLOB_RECURSE and |
| <glob_exp> is a globbing expression used with “file(GLOB” or |
| “file(GLOB_RECURSE” to retrieve a list of matching files. If a |
| matching file is executable, its prerequisites are listed.</p> |
| <p>Any additional (optional) arguments provided are passed along as the |
| optional arguments to the list_prerequisites calls.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GP_APPEND_UNIQUE</span><span class="p">(</span><span class="o"><</span><span class="n">list_var</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Append <value> to the list variable <list_var> only if the value is |
| not already in the list.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">IS_FILE_EXECUTABLE</span><span class="p">(</span><span class="o"><</span><span class="n">file</span><span class="o">></span> <span class="o"><</span><span class="n">result_var</span><span class="o">></span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Return 1 in <result_var> if <file> is a binary executable, 0 |
| otherwise.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GP_ITEM_DEFAULT_EMBEDDED_PATH</span><span class="p">(</span><span class="o"><</span><span class="n">item</span><span class="o">></span> <span class="o"><</span><span class="n">default_embedded_path_var</span><span class="o">></span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Return the path that others should refer to the item by when the item |
| is embedded inside a bundle.</p> |
| <p>Override on a per-project basis by providing a project-specific |
| gp_item_default_embedded_path_override function.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GP_RESOLVE_ITEM</span><span class="p">(</span><span class="o"><</span><span class="n">context</span><span class="o">></span> <span class="o"><</span><span class="n">item</span><span class="o">></span> <span class="o"><</span><span class="n">exepath</span><span class="o">></span> <span class="o"><</span><span class="n">dirs</span><span class="o">></span> <span class="o"><</span><span class="n">resolved_item_var</span><span class="o">></span> |
| <span class="p">[</span><span class="o"><</span><span class="n">rpaths</span><span class="o">></span><span class="p">])</span> |
| </pre></div> |
| </div> |
| <p>Resolve an item into an existing full path file.</p> |
| <p>Override on a per-project basis by providing a project-specific |
| gp_resolve_item_override function.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GP_RESOLVED_FILE_TYPE</span><span class="p">(</span><span class="o"><</span><span class="n">original_file</span><span class="o">></span> <span class="o"><</span><span class="n">file</span><span class="o">></span> <span class="o"><</span><span class="n">exepath</span><span class="o">></span> <span class="o"><</span><span class="n">dirs</span><span class="o">></span> <span class="o"><</span><span class="n">type_var</span><span class="o">></span> |
| <span class="p">[</span><span class="o"><</span><span class="n">rpaths</span><span class="o">></span><span class="p">])</span> |
| </pre></div> |
| </div> |
| <p>Return the type of <file> with respect to <original_file>. String |
| describing type of prerequisite is returned in variable named |
| <type_var>.</p> |
| <p>Use <exepath> and <dirs> if necessary to resolve non-absolute <file> |
| values – but only for non-embedded items.</p> |
| <p>Possible types are:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">system</span> |
| <span class="n">local</span> |
| <span class="n">embedded</span> |
| <span class="n">other</span> |
| </pre></div> |
| </div> |
| <p>Override on a per-project basis by providing a project-specific |
| gp_resolved_file_type_override function.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GP_FILE_TYPE</span><span class="p">(</span><span class="o"><</span><span class="n">original_file</span><span class="o">></span> <span class="o"><</span><span class="n">file</span><span class="o">></span> <span class="o"><</span><span class="n">type_var</span><span class="o">></span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Return the type of <file> with respect to <original_file>. String |
| describing type of prerequisite is returned in variable named |
| <type_var>.</p> |
| <p>Possible types are:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">system</span> |
| <span class="n">local</span> |
| <span class="n">embedded</span> |
| <span class="n">other</span> |
| </pre></div> |
| </div> |
| </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="GenerateExportHeader.html" |
| title="previous chapter">GenerateExportHeader</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="GNUInstallDirs.html" |
| title="next chapter">GNUInstallDirs</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/module/GetPrerequisites.rst.txt" |
| rel="nofollow">Show Source</a></li> |
| </ul> |
| </div> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3>Quick search</h3> |
| <form class="search" action="../search.html" method="get"> |
| <div><input type="text" name="q" /></div> |
| <div><input type="submit" value="Go" /></div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </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="GNUInstallDirs.html" title="GNUInstallDirs" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="GenerateExportHeader.html" title="GenerateExportHeader" |
| >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.8.2 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" >cmake-modules(7)</a> »</li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2017 Kitware, Inc. and Contributors. |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2. |
| </div> |
| </body> |
| </html> |
