mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
317 lines
14 KiB
HTML
317 lines
14 KiB
HTML
<!-- 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="module">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
DoxygenAwesomeParagraphLink.init()
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
DoxygenAwesomeTabs.init()
|
|
await new Promise(r => window.addEventListener('DOMContentLoaded', r));
|
|
// Remove title when a img[alt='title-img'] is present.
|
|
// Find an image with the alt "img-title".
|
|
const img = document.querySelector("img[alt='title-img']");
|
|
const header = document.querySelector(".headertitle");
|
|
if (img && header) {
|
|
// Hide the header title progressively.
|
|
header.style.display = "none";
|
|
// Show progressively the image.
|
|
img.style.maxHeight = "40vh";
|
|
img.style.maxWidth = "100%";
|
|
img.style.objectFit = "contain";
|
|
}
|
|
// In the "examples.html" page. Turn every link with text
|
|
// "examples/<...>
|
|
//
|
|
// Add a "demo" link toward.
|
|
// https://arthursonzogni.github.io/FTXUI/examples/?file=<...>
|
|
const examples = document.querySelectorAll("a")
|
|
examples.forEach((example) => {
|
|
if (!example.textContent.startsWith("examples/")) {
|
|
return;
|
|
}
|
|
// Remove the ".cpp" extension from the example name.
|
|
const exampleName = example.textContent.replace("examples/", "").replace(".cpp", "");
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + exampleName;
|
|
a.style.marginRight= "1em";
|
|
a.style.fontWeight = "bold";
|
|
example.parentElement.insertBefore(a, example)
|
|
});
|
|
// If the current URL ends with -example.html, we can add a link to the demo
|
|
// as well using the div.title textContent.
|
|
const url = new URL(window.location.href);
|
|
if (url.pathname.endsWith("-example.html")) {
|
|
// Get the title text.
|
|
const title = document.querySelector("div.title").textContent;
|
|
const example = title.replace("examples/", "").replace(".cpp", "");
|
|
// Create a link to the demo.
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + example;
|
|
a.style.marginLeft = "1em";
|
|
a.style.fontWeight = "bold";
|
|
a.style.display = "inline-block";
|
|
// Insert the link after the title.
|
|
const titleDiv = document.querySelector("div.title");
|
|
if (titleDiv) {
|
|
titleDiv.insertBefore(a, titleDiv.nextSibling);
|
|
}
|
|
}
|
|
</script>
|
|
<script type="module">
|
|
// Click on the navtree, except for the main page where this is already done
|
|
// automatically.
|
|
let delay = 0;
|
|
while(true) {
|
|
const navtree = document.querySelector("div.item.selected");
|
|
if (!navtree) {
|
|
delay *= 2;
|
|
delay += 1;
|
|
await new Promise(resolve => setTimeout(resolve, delay));
|
|
continue;
|
|
}
|
|
// Include only selected navtree items.
|
|
console.log("navtree.textContent", navtree.textContent);
|
|
if (!navtree.textContent.includes("Getting Started") &&
|
|
!navtree.textContent.includes("Installation") &&
|
|
!navtree.textContent.includes("ftxui / screen") &&
|
|
!navtree.textContent.includes("ftxui / dom") &&
|
|
!navtree.textContent.includes("ftxui / component") &&
|
|
!navtree.textContent.includes("Reference")) {
|
|
break;
|
|
}
|
|
// Find the first link inside the navtree.
|
|
const link = navtree.querySelector("a");
|
|
if (link) {
|
|
// Simulate a click on the link.
|
|
link.click();
|
|
break;
|
|
}
|
|
}
|
|
</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"> 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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&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="#methods-of-integration">Methods of Integration</a>
|
|
<ul>
|
|
<li class="level2">
|
|
<a href="#using-fetchcontent">Using FetchContent</a>
|
|
</li>
|
|
<li class="level2">
|
|
<a href="#using-find_package">Using find_package</a>
|
|
</li>
|
|
<li class="level2">
|
|
<a href="#using-git-submodule">Using git submodule</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="level1">
|
|
<a href="#optional-cmake-flags">Optional CMake Flags</a>
|
|
</li>
|
|
<li class="level1">
|
|
<a href="#verifying-integration">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="methods-of-integration"></a>
|
|
Methods of Integration</h1>
|
|
<h2><a class="anchor" id="using-fetchcontent"></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(ftxui</div>
|
|
<div class="line"> GIT_REPOSITORY https://github.com/ArthurSonzogni/FTXUI</div>
|
|
<div class="line"> GIT_TAG v6.1.9 # Replace with a version, tag, or commit hash</div>
|
|
<div class="line">)</div>
|
|
<div class="line"> </div>
|
|
<div class="line">FetchContent_MakeAvailable(ftxui)</div>
|
|
<div class="line"> </div>
|
|
<div class="line">add_executable(main main.cpp)</div>
|
|
<div class="line">target_link_libraries(main</div>
|
|
<div class="line"> PRIVATE ftxui::screen</div>
|
|
<div class="line"> PRIVATE ftxui::dom</div>
|
|
<div class="line"> PRIVATE ftxui::component</div>
|
|
<div class="line">)</div>
|
|
</div><!-- fragment --><p>This ensures reproducible builds and easy dependency management.</p>
|
|
<h2><a class="anchor" id="using-find_package"></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">find_package(ftxui REQUIRED)</div>
|
|
<div class="line"> </div>
|
|
<div class="line">add_executable(main main.cpp)</div>
|
|
<div class="line">target_link_libraries(main</div>
|
|
<div class="line"> PRIVATE ftxui::screen</div>
|
|
<div class="line"> PRIVATE ftxui::dom</div>
|
|
<div class="line"> PRIVATE ftxui::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="using-git-submodule"></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/FTXUI external/ftxui</div>
|
|
<div class="line">git submodule update --init --recursive</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 <your-repo></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(external/ftxui)</div>
|
|
<div class="line"> </div>
|
|
<div class="line">add_executable(main main.cpp)</div>
|
|
<div class="line">target_link_libraries(main</div>
|
|
<div class="line"> PRIVATE ftxui::screen</div>
|
|
<div class="line"> PRIVATE ftxui::dom</div>
|
|
<div class="line"> PRIVATE ftxui::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="optional-cmake-flags"></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="verifying-integration"></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>
|