zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-12-16 01:48:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
1c5ada2f2ee0ffa56285f061a9d54abd0c2669b6
FTXUI/installation_cmake.html
ArthurSonzogni 1c5ada2f2e deploy: deae56888a
2025-05-29 07:37:37 +00:00

236 lines
14 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FTXUI: CMake</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeParagraphLink.init()
DoxygenAwesomeInteractiveToc.init()
DoxygenAwesomeTabs.init()
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">FTXUI<span id="projectnumber">&#160;6.1.9</span>
</div>
<div id="projectbrief">C++ functional terminal UI.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('installation_cmake.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">CMake</div></div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul>
<li class="level1">
<a href="#autotoc_md15">Methods of Integration</a>
<ul>
<li class="level2">
<a href="#autotoc_md16">Using FetchContent</a>
</li>
<li class="level2">
<a href="#autotoc_md17">Using find_package</a>
</li>
<li class="level2">
<a href="#autotoc_md18">Using git submodule</a>
</li>
</ul>
</li>
<li class="level1">
<a href="#autotoc_md19">Optional CMake Flags</a>
</li>
<li class="level1">
<a href="#autotoc_md20">Verifying Integration</a>
</li>
</ul>
</div>
<div class="textblock"><p>This page explains how to depend on FTXUI using <a href="https://cmake.org">CMake</a>. <br />
</p>
<h1><a class="anchor" id="autotoc_md15"></a>
Methods of Integration</h1>
<h2><a class="anchor" id="autotoc_md16"></a>
Using FetchContent</h2>
<p>This approach downloads FTXUI at configure time and doesn't require a system-wide install.</p>
<div class="fragment"><div class="line">include(fetchcontent)</div>
<div class="line"> </div>
<div class="line">fetchcontent_declare(<a class="code hl_namespace" href="namespaceftxui.html">ftxui</a></div>
<div class="line"> git_repository https://github.com/arthursonzogni/<a class="code hl_namespace" href="namespaceftxui.html">ftxui</a></div>
<div class="line"> git_tag v6.1.9 <span class="preprocessor"># Replace with a version, tag, or commit hash</span></div>
<div class="line"><span class="preprocessor"></span>)</div>
<div class="line"> </div>
<div class="line">fetchcontent_makeavailable(<a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>)</div>
<div class="line"> </div>
<div class="line">add_executable(<a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>.cpp)</div>
<div class="line">target_link_libraries(<a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::screen</div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::dom</div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::component</div>
<div class="line">)</div>
<div class="ttc" id="aexamples_2component_2button_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> <a href="examples_2component_2button_8cpp_source.html#l00004">examples/component/button.cpp:4</a></div></div>
<div class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00010">animation.hpp:10</a></div></div>
</div><!-- fragment --><p>This ensures reproducible builds and easy dependency management.</p>
<h2><a class="anchor" id="autotoc_md17"></a>
Using find_package</h2>
<p>If FTXUI is installed system-wide or via a package manager (e.g. vcpkg or Conan), you can use:</p>
<div class="fragment"><div class="line">fortranind_package(<a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> required)</div>
<div class="line"> </div>
<div class="line">add_executable(<a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>.cpp)</div>
<div class="line">target_link_libraries(<a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::screen</div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::dom</div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::component</div>
<div class="line">)</div>
</div><!-- fragment --><p>Make sure the package is visible in your <code>CMAKE_PREFIX_PATH</code>.</p>
<h2><a class="anchor" id="autotoc_md18"></a>
Using git submodule</h2>
<p>You can also add FTXUI as a <a href="https://git-scm.com/book/en/v2/Git-Tools-Submodules">Git submodule</a>, keeping it as part of your repository:</p>
<div class="fragment"><div class="line">git submodule add https://github.com/arthursonzogni/<a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> <span class="keywordtype">external</span>/ftxui</div>
<div class="line">git submodule update --init --<span class="keywordtype">recursive</span></div>
</div><!-- fragment --><p>When cloning a repository that already includes FTXUI as a submodule, make sure to fetch submodules with:</p>
<div class="fragment"><div class="line">git clone --recurse-submodules &lt;your-repo&gt;</div>
<div class="line"># Or, if already cloned:</div>
<div class="line">git submodule update --init --recursive</div>
</div><!-- fragment --><p>Then in your <code>CMakeLists.txt</code>:</p>
<div class="fragment"><div class="line">add_subdirectory(<span class="keywordtype">external</span>/ftxui)</div>
<div class="line"> </div>
<div class="line">add_executable(<a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>.cpp)</div>
<div class="line">target_link_libraries(<a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::screen</div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::dom</div>
<div class="line"> <span class="keywordtype">PRIVATE</span> <a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>::component</div>
<div class="line">)</div>
</div><!-- fragment --><p>This approach works well if you want to vendor FTXUI in your own repository.</p>
<h1><a class="anchor" id="autotoc_md19"></a>
Optional CMake Flags</h1>
<p>FTXUI supports the following CMake options:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Option </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Default </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">FTXUI_BUILD_EXAMPLES </td><td class="markdownTableBodyNone">Build bundled examples </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">FTXUI_BUILD_DOCS </td><td class="markdownTableBodyNone">Build the documentation </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">FTXUI_BUILD_TESTS </td><td class="markdownTableBodyNone">Enable tests </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">FTXUI_ENABLE_INSTALL </td><td class="markdownTableBodyNone">Generate install targets </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">FTXUI_MICROSOFT_TERMINAL_FALLBACK </td><td class="markdownTableBodyNone">Improve Windows compatibility </td><td class="markdownTableBodyNone">ON/OFF </td></tr>
</table>
<p>To enable an option:</p>
<div class="fragment"><div class="line">cmake -DFTXUI_BUILD_EXAMPLES=ON ..</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md20"></a>
Verifying Integration</h1>
<p>To confirm the setup is working, build and run a minimal example. If you need a complete template, see: <a href="https://github.com/ArthurSonzogni/ftxui-starter">ftxui-starter</a></p>
<div class="section_buttons"></div><div class="section_buttons"><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Previous </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a href="getting-started.html">Getting Started</a> </td></tr>
</table>
</div><div class="section_buttons"></div> </div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.8-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="installation.html">Installation</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink