Mirror/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-11-15 11:38:56 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
FTXUI/md_doc_2posix__pipe.html
ArthurSonzogni 4aab714d3f deploy: 229cae78b5
2025-11-12 12:56:59 +00:00

297 lines
14 KiB
HTML
Raw Permalink 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: POSIX Piped Input in FTXUI</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">&#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('md_doc_2posix__pipe.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">POSIX Piped Input in FTXUI</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="posix-piped-input-in-ftxui"></a></p>
<dl class="section warning"><dt>Warning</dt><dd>This feature works only on Linux and macOS. It is not supported on Windows and WebAssembly.</dd></dl>
<h1><a class="anchor" id="what-is-a-posix-pipe"></a>
What is a POSIX Pipe?</h1>
<p>A POSIX pipe is a way for two separate programs to communicate. One program sends its output directly as input to another program. Think of it like a one-way tube for data.</p>
<p><b>Example:</b></p>
<p>Imagine you want to list files and then filter them interactively.</p>
<ul>
<li><code>ls</code>: Lists files.</li>
<li><code>interactive_grep</code>: An FTXUI application that filters text and lets you type.</li>
</ul>
<p>You can connect them with a pipe (<code>|</code>):</p>
<div class="fragment"><div class="line">ls -l | interactive_grep</div>
</div><!-- fragment --><p>Here's what happens:</p><ol type="1">
<li><code>ls -l</code> lists files with details.</li>
<li>The <code>|</code> sends this list directly to <code>interactive_grep</code>.</li>
<li><code>interactive_grep</code> receives the list and displays it. Because it's an FTXUI app, you can then type to filter the list, even though it received initial data from <code>ls</code>.</li>
</ol>
<h1><a class="anchor" id="how-ftxui-handles-piped-input"></a>
How FTXUI Handles Piped Input</h1>
<p>Now that you understand what a POSIX pipe is, let's look at how FTXUI uses them.</p>
<p>FTXUI lets your application read data from other programs (like from a pipe) while still allowing you to use your keyboard for interaction. This is useful for interactive command-line tools that process data.</p>
<p>Normally, FTXUI applications receive all input from <code>stdin</code>. However, when FTXUI detects that <code>stdin</code> is connected to the output of a pipe (meaning data is being piped into your application), it automatically switches to reading interactive keyboard input from <code>/dev/tty</code>. This ensures that your application can still receive user input even while processing piped data.</p>
<p>This feature is <b>turned on by default</b>.</p>
<p>If your FTXUI application needs to read piped data and also respond to keyboard input, you typically don't need to do anything special:</p>
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ScreenInteractive::Fullscreen();</div>
<div class="line"><span class="comment">// screen.HandlePipedInput(true); // This is enabled by default</span></div>
<div class="line">screen.Loop(component);</div>
</div><!-- fragment --><h1><a class="anchor" id="turning-off-piped-input"></a>
Turning Off Piped Input</h1>
<p>If you don't need this feature, or if it conflicts with your custom input handling, you can turn it off.</p>
<p>To disable it, call <code>HandlePipedInput(false)</code> before starting your application's main loop:</p>
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ScreenInteractive::Fullscreen();</div>
<div class="line">screen.HandlePipedInput(<span class="keyword">false</span>); <span class="comment">// Turn off piped input handling</span></div>
<div class="line">screen.Loop(component);</div>
</div><!-- fragment --> </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! -->
</div>
<script>
document.addEventListener('DOMContentLoaded', function() {
const projectNumber = document.getElementById('projectnumber');
if (!projectNumber) {
console.warn('Doxygen element with ID "projectnumber" not found. Cannot add version switcher.');
return;
}
const versions = ["main", "v6.1.9", "v6.1.8", "v6.1.7", "v6.1.6", "v6.1.5", "v6.1.4", "v6.1.3", "v6.1.2", "v6.1.1", "v6.1.0", "v6.0.2", "v6.0.1", "v6.0.0", "v5.0.0", "v4.1.1", "v4.1.0", "v4.0.0", "v3.0.0", "v2.0.0", "v0.9", "v0.11", "v0.10"];
const version_paths = {"main": "index.html", "v6.1.9": "en/v6.1.9/index.html", "v6.1.8": "en/v6.1.8/index.html", "v6.1.7": "en/v6.1.7/index.html", "v6.1.6": "en/v6.1.6/index.html", "v6.1.5": "en/v6.1.5/index.html", "v6.1.4": "en/v6.1.4/index.html", "v6.1.3": "en/v6.1.3/index.html", "v6.1.2": "en/v6.1.2/index.html", "v6.1.1": "en/v6.1.1/index.html", "v6.1.0": "en/v6.1.0/index.html", "v6.0.2": "en/v6.0.2/index.html", "v6.0.1": "en/v6.0.1/index.html", "v6.0.0": "en/v6.0.0/index.html", "v5.0.0": "en/v5.0.0/index.html", "v4.1.1": "en/v4.1.1/index.html", "v4.1.0": "en/v4.1.0/index.html", "v4.0.0": "en/v4.0.0/index.html", "v3.0.0": "en/v3.0.0/index.html", "v2.0.0": "en/v2.0.0/index.html", "v0.9": "en/v0.9/index.html", "v0.11": "en/v0.11/index.html", "v0.10": "en/v0.10/index.html"};
const currentVersion = "main";
// Sort versions: 'main' first, then others numerically descending.
versions.sort((a, b) => {
if (a === 'main') return -1;
if (b === 'main') return 1;
return b.localeCompare(a, undefined, { numeric: true, sensitivity: 'base' });
});
const select = document.createElement('select');
select.onchange = function() {
const selectedVersion = this.value;
// Navigate directly to the pre-calculated relative path.
if (selectedVersion !== currentVersion) {
window.location.href = version_paths[selectedVersion];
}
};
versions.forEach(v => {
const option = document.createElement('option');
option.value = v;
option.textContent = v;
if (v === currentVersion) {
option.selected = true;
}
select.appendChild(option);
});
// Replace the Doxygen project number element with our dropdown.
projectNumber.replaceWith(select);
// Apply some styling to make it look good.
Object.assign(select.style, {
backgroundColor: 'rgba(0, 0, 0, 0.8)',
color: 'white',
border: '1px solid rgba(255, 255, 255, 0.2)',
padding: '5px',
borderRadius: '5px',
fontSize: '14px',
fontFamily: 'inherit',
marginLeft: '10px',
cursor: 'pointer'
});
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink