| |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>CheckFortranSourceCompiles — 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="CheckFortranSourceRuns" href="CheckFortranSourceRuns.html" /> |
| <link rel="prev" title="CheckFortranFunctionExists" href="CheckFortranFunctionExists.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="CheckFortranSourceRuns.html" title="CheckFortranSourceRuns" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="CheckFortranFunctionExists.html" title="CheckFortranFunctionExists" |
| 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="">CheckFortranSourceCompiles</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="checkfortransourcecompiles"> |
| <span id="module:CheckFortranSourceCompiles"></span><h1>CheckFortranSourceCompiles<a class="headerlink" href="#checkfortransourcecompiles" title="Permalink to this headline">¶</a></h1> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.1.</span></p> |
| </div> |
| <p>Check if given Fortran source compiles and links into an executable.</p> |
| <dl class="cmake command"> |
| <dt class="sig sig-object cmake" id="command:check_fortran_source_compiles"> |
| <span class="sig-name descname"><span class="pre">check_fortran_source_compiles</span></span><a class="headerlink" href="#command:check_fortran_source_compiles" title="Permalink to this definition">¶</a></dt> |
| <dd><div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">check_fortran_source_compiles(</span><span class="nv"><code></span><span class="w"> </span><span class="nv"><resultVar></span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">FAIL_REGEX</span><span class="w"> </span><span class="nv"><regex>...</span><span class="p">]</span><span class="w"></span> |
| <span class="w"> </span><span class="p">[</span><span class="no">SRC_EXT</span><span class="w"> </span><span class="nv"><extension></span><span class="p">]</span><span class="w"></span> |
| <span class="nf">)</span><span class="w"></span> |
| </pre></div> |
| </div> |
| <p>Checks that the source supplied in <code class="docutils literal notranslate"><span class="pre"><code></span></code> can be compiled as a Fortran |
| source file and linked as an executable. The <code class="docutils literal notranslate"><span class="pre"><code></span></code> must be a Fortran program |
| containing at least an <code class="docutils literal notranslate"><span class="pre">end</span></code> statement--for example:</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">check_fortran_source_compiles(</span><span class="s">"character :: b; error stop b; end"</span><span class="w"> </span><span class="no">F2018ESTOPOK</span><span class="w"> </span><span class="no">SRC_EXT</span><span class="w"> </span><span class="no">F90</span><span class="nf">)</span><span class="w"></span> |
| </pre></div> |
| </div> |
| <p>This command can help avoid costly build processes when a compiler lacks support |
| for a necessary feature, or a particular vendor library is not compatible with |
| the Fortran compiler version being used. This generate-time check may advise the |
| user of such before the main build process. See also the |
| <span class="target" id="index-0-command:check_fortran_source_runs"></span><a class="reference internal" href="CheckFortranSourceRuns.html#command:check_fortran_source_runs" title="check_fortran_source_runs"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">check_fortran_source_runs()</span></code></a> command to actually run the compiled code.</p> |
| <p>The result will be stored in the internal cache |
| variable <code class="docutils literal notranslate"><span class="pre"><resultVar></span></code>, with a boolean true value for success and boolean |
| false for failure.</p> |
| <p>If <code class="docutils literal notranslate"><span class="pre">FAIL_REGEX</span></code> is provided, then failure is determined by checking |
| if anything in the output matches any of the specified regular expressions.</p> |
| <p>By default, the test source file will be given a <code class="docutils literal notranslate"><span class="pre">.F</span></code> file extension. The |
| <code class="docutils literal notranslate"><span class="pre">SRC_EXT</span></code> option can be used to override this with <code class="docutils literal notranslate"><span class="pre">.<extension></span></code> instead-- |
| <code class="docutils literal notranslate"><span class="pre">.F90</span></code> is a typical choice.</p> |
| <p>The underlying check is performed by the <span class="target" id="index-0-command:try_compile"></span><a class="reference internal" href="../command/try_compile.html#command:try_compile" title="try_compile"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">try_compile()</span></code></a> command. The |
| compile and link commands can be influenced by setting any of the following |
| variables prior to calling <code class="docutils literal notranslate"><span class="pre">check_fortran_source_compiles()</span></code>:</p> |
| <dl> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_FLAGS</span></code></dt><dd><p>Additional flags to pass to the compiler. Note that the contents of |
| <span class="target" id="index-0-variable:CMAKE_<LANG>_FLAGS"></span><a class="reference internal" href="../variable/CMAKE_LANG_FLAGS.html#variable:CMAKE_<LANG>_FLAGS" title="CMAKE_<LANG>_FLAGS"><code class="xref cmake cmake-variable docutils literal notranslate"><span class="pre">CMAKE_Fortran_FLAGS</span></code></a> and its associated |
| configuration-specific variable are automatically added to the compiler |
| command before the contents of <code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_FLAGS</span></code>.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_DEFINITIONS</span></code></dt><dd><p>A <a class="reference internal" href="../manual/cmake-language.7.html#cmake-language-lists"><span class="std std-ref">;-list</span></a> of compiler definitions of the form |
| <code class="docutils literal notranslate"><span class="pre">-DFOO</span></code> or <code class="docutils literal notranslate"><span class="pre">-DFOO=bar</span></code>. A definition for the name specified by |
| <code class="docutils literal notranslate"><span class="pre"><resultVar></span></code> will also be added automatically.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_INCLUDES</span></code></dt><dd><p>A <a class="reference internal" href="../manual/cmake-language.7.html#cmake-language-lists"><span class="std std-ref">;-list</span></a> of header search paths to pass to |
| the compiler. These will be the only header search paths used by |
| <code class="docutils literal notranslate"><span class="pre">try_compile()</span></code>, i.e. the contents of the <span class="target" id="index-0-prop_dir:INCLUDE_DIRECTORIES"></span><a class="reference internal" href="../prop_dir/INCLUDE_DIRECTORIES.html#prop_dir:INCLUDE_DIRECTORIES" title="INCLUDE_DIRECTORIES"><code class="xref cmake cmake-prop_dir docutils literal notranslate"><span class="pre">INCLUDE_DIRECTORIES</span></code></a> |
| directory property will be ignored.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_LINK_OPTIONS</span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.14.</span></p> |
| </div> |
| <p>A <a class="reference internal" href="../manual/cmake-language.7.html#cmake-language-lists"><span class="std std-ref">;-list</span></a> of options to add to the link |
| command (see <span class="target" id="index-1-command:try_compile"></span><a class="reference internal" href="../command/try_compile.html#command:try_compile" title="try_compile"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">try_compile()</span></code></a> for further details).</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_LIBRARIES</span></code></dt><dd><p>A <a class="reference internal" href="../manual/cmake-language.7.html#cmake-language-lists"><span class="std std-ref">;-list</span></a> of libraries to add to the link |
| command. These can be the name of system libraries or they can be |
| <a class="reference internal" href="../manual/cmake-buildsystem.7.html#imported-targets"><span class="std std-ref">Imported Targets</span></a> (see <span class="target" id="index-2-command:try_compile"></span><a class="reference internal" href="../command/try_compile.html#command:try_compile" title="try_compile"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">try_compile()</span></code></a> for |
| further details).</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_QUIET</span></code></dt><dd><p>If this variable evaluates to a boolean true value, all status messages |
| associated with the check will be suppressed.</p> |
| </dd> |
| </dl> |
| <p>The check is only performed once, with the result cached in the variable |
| named by <code class="docutils literal notranslate"><span class="pre"><resultVar></span></code>. Every subsequent CMake run will re-use this cached |
| value rather than performing the check again, even if the <code class="docutils literal notranslate"><span class="pre"><code></span></code> changes. |
| In order to force the check to be re-evaluated, the variable named by |
| <code class="docutils literal notranslate"><span class="pre"><resultVar></span></code> must be manually removed from the cache.</p> |
| </dd></dl> |
| |
| </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="CheckFortranFunctionExists.html" |
| title="previous chapter">CheckFortranFunctionExists</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="CheckFortranSourceRuns.html" |
| title="next chapter">CheckFortranSourceRuns</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/module/CheckFortranSourceCompiles.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="CheckFortranSourceRuns.html" title="CheckFortranSourceRuns" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="CheckFortranFunctionExists.html" title="CheckFortranFunctionExists" |
| >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="">CheckFortranSourceCompiles</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> |
