mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
369 lines
18 KiB
HTML
369 lines
18 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: C++20 Modules</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('cpp20-modules.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">C++20 Modules</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="textblock"><dl class="section warning"><dt>Warning</dt><dd>この機能はまだ開発中であり、APIは将来のリリースで変更される可能性があります。 FTXUIにおけるC++モジュールの互換性と使いやすさの向上にご協力をお願いします。 何か問題に遭遇した場合や提案がある場合は、issueをオープンしてください。</dd></dl>
|
||
<p>FTXUIは、コンパイル時間の短縮とコード構成の改善のために、<a href="https://en.cppreference.com/w/cpp/language/modules">C++20モジュール</a>を実験的にサポートしています。ライブラリの各部分は対応するモジュールを持ち、各ヘッダーごとにパーティションに分割されています。</p>
|
||
<p>C++20モジュールを提供するためにFTXUIプロジェクト自体をビルドするには、FTXUI_BUILD_MODULESオプションを使用します。例えば、CMakeとNinjaを使用する場合：</p>
|
||
<div class="fragment"><div class="line">cmake \</div>
|
||
<div class="line"> -DCMAKE_GENERATOR=Ninja \</div>
|
||
<div class="line"> -DFTXUI_BUILD_MODULES=ON \</div>
|
||
<div class="line"> ..</div>
|
||
<div class="line"> </div>
|
||
<div class="line">ninja</div>
|
||
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>モジュールを使用するには、C++≥20互換コンパイラ、CMakeバージョン3.20以降、およびNinjaのような互換性のあるジェネレータが必要です。Makefileジェネレータは**モジュールをサポートしていません**のでご注意ください。</dd></dl>
|
||
<p>次に、ご自身のコードでモジュールを通常通り使用できます。</p>
|
||
<div class="fragment"><div class="line"><span class="keyword">import</span> <a class="code" href="module__ftxui.html">ftxui</a>;</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="keyword">using </span>ftxui::Button;</div>
|
||
<div class="line"><span class="keyword">using </span><a class="code hl_class" href="group__component.html#classftxui_1_1ScreenInteractive">ftxui::ScreenInteractive</a>;</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="keywordtype">int</span> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
|
||
<div class="line"> <span class="keyword">auto</span> screen = ScreenInteractive::TerminalOutput();</div>
|
||
<div class="line"> <span class="keyword">auto</span> button = Button(<span class="stringliteral">"Click me"</span>, screen.QuitClosure());</div>
|
||
<div class="line"> screen.Loop(button);</div>
|
||
<div class="line"> <span class="keywordflow">return</span> 0;</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#l00033">examples/component/button.cpp:33</a></div></div>
|
||
<div class="ttc" id="agroup__component_html_classftxui_1_1ScreenInteractive"><div class="ttname"><a href="group__component.html#classftxui_1_1ScreenInteractive">ftxui::ScreenInteractive</a></div><div class="ttdoc">ScreenInteractive はイベントを処理し、メインループを実行し、コンポーネントを管理できる Screen です。</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8hpp_source.html#l00034">screen_interactive.hpp:34</a></div></div>
|
||
<div class="ttc" id="amodule__ftxui_html"><div class="ttname"><a href="module__ftxui.html">ftxui</a></div><div class="ttdoc">FTXUIのすべてのサブモジュールを再エクスポートするモジュールファイルです。</div></div>
|
||
</div><!-- fragment --><p>ftxui`コンビニエンスモジュールは、すべてのモジュールをまとめるだけのものです。</p>
|
||
<div class="fragment"><div class="line"><span class="keyword">export</span> <span class="keyword">import</span> <a class="code" href="module__ftxui_8component.html">ftxui.component</a>;</div>
|
||
<div class="line"><span class="keyword">export</span> <span class="keyword">import</span> <a class="code" href="module__ftxui_8dom.html">ftxui.dom</a>;</div>
|
||
<div class="line"><span class="keyword">export</span> <span class="keyword">import</span> <a class="code" href="module__ftxui_8screen.html">ftxui.screen</a>;</div>
|
||
<div class="line"><span class="keyword">export</span> <span class="keyword">import</span> <a class="code" href="module__ftxui_8util.html">ftxui.util</a>;</div>
|
||
<div class="ttc" id="amodule__ftxui_8component_html"><div class="ttname"><a href="module__ftxui_8component.html">ftxui.component</a></div><div class="ttdoc">FTXUIコンポーネント操作用モジュールファイルです。</div></div>
|
||
<div class="ttc" id="amodule__ftxui_8dom_html"><div class="ttname"><a href="module__ftxui_8dom.html">ftxui.dom</a></div><div class="ttdoc">FTXUI DOM操作用モジュールファイルです。</div></div>
|
||
<div class="ttc" id="amodule__ftxui_8screen_html"><div class="ttname"><a href="module__ftxui_8screen.html">ftxui.screen</a></div><div class="ttdoc">FTXUIスクリーン操作のためのモジュールファイル。</div></div>
|
||
<div class="ttc" id="amodule__ftxui_8util_html"><div class="ttname"><a href="module__ftxui_8util.html">ftxui.util</a></div><div class="ttdoc">FTXUIユーティリティ操作用のモジュールファイル。</div></div>
|
||
</div><!-- fragment --><p> 必要に応じて、必要なモジュールのみをインポートすることもできます。</p>
|
||
<p>CMakeでモジュールを適切に見つけてリンクするには、<code>target_link_libraries</code>を使用して適切なコンパイラ、リンカなどのフラグを取得します。</p>
|
||
<div class="fragment"><div class="line">target_link_libraries(my_executable</div>
|
||
<div class="line"> #...whatever...</div>
|
||
<div class="line"> PRIVATE ftxui::modules</div>
|
||
<div class="line">)</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="モジュールリスト"></a>
|
||
モジュールリスト</h3>
|
||
<p>モジュールは、対応するヘッダー、またはより便利なインターフェースを提供するための関連ヘッダーのグループを直接参照します。以下のモジュールが利用可能です。</p>
|
||
<ul>
|
||
<li><code>ftxui</code><ul>
|
||
<li><code>ftxui.component</code></li>
|
||
<li><code>ftxui.dom</code></li>
|
||
<li><code>ftxui.screen</code></li>
|
||
<li><code><a class="el" href="namespaceftxui_1_1util.html">ftxui.util</a></code> </li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</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('projectname');
|
||
|
||
if (!projectNumber) {
|
||
console.warn('Doxygen element with ID "projectnumber" not found. Cannot add version switcher.');
|
||
return;
|
||
}
|
||
|
||
const langs = ["en", "es", "fr", "ja", "zh-CH", "zh-TW"];
|
||
const lang_paths = {"en": "../index.html", "es": "../es/index.html", "fr": "../fr/index.html", "ja": "index.html", "zh-CH": "../zh-CH/index.html", "zh-TW": "../zh-TW/index.html"};
|
||
const lang_display = {"en": "English", "es": "Espa\u00f1ol", "fr": "Fran\u00e7ais", "ja": "\u65e5\u672c\u8a9e", "zh-CH": "\u4e2d\u6587 (\u7b80\u4f53)", "zh-TW": "\u4e2d\u6587 (\u7e41\u9ad4)"};
|
||
const versions = ["main"];
|
||
const version_paths = {"main": "index.html"};
|
||
const currentLang = "ja";
|
||
const currentVersion = "main";
|
||
|
||
// Helper function to create a styled select element
|
||
const createSelect = (options, current, paths, label, displayMap = null) => {
|
||
const select = document.createElement('select');
|
||
select.title = label;
|
||
select.onchange = function() {
|
||
const selectedValue = this.value;
|
||
if (selectedValue in paths) {
|
||
window.location.href = paths[selectedValue];
|
||
}
|
||
};
|
||
|
||
// Sort versions: 'main' first, then others numerically descending.
|
||
options.sort((a, b) => {
|
||
if (a === 'main') return -1;
|
||
if (b === 'main') return 1;
|
||
return b.localeCompare(a, undefined, { numeric: true, sensitivity: 'base' });
|
||
});
|
||
|
||
options.forEach(v => {
|
||
const option = document.createElement('option');
|
||
option.value = v;
|
||
// Use the displayMap if provided, otherwise default to the value (v)
|
||
option.textContent = displayMap ? displayMap[v] : v;
|
||
if (v === current) {
|
||
option.selected = true;
|
||
}
|
||
select.appendChild(option);
|
||
});
|
||
|
||
// 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',
|
||
margin: '0 5px 0 0',
|
||
cursor: 'pointer'
|
||
});
|
||
return select;
|
||
};
|
||
|
||
// 1. Create Language Switcher, passing the language display names map
|
||
const langSelect = createSelect(langs, currentLang, lang_paths, 'Select Language', lang_display);
|
||
|
||
// 2. Create Version Switcher
|
||
const versionSelect = createSelect(versions, currentVersion, version_paths, 'Select Version');
|
||
|
||
// 3. Create FTXUI title.
|
||
const ftxuiTitle = document.createElement('span');
|
||
ftxuiTitle.textContent = 'FTXUI: ';
|
||
Object.assign(ftxuiTitle.style, {
|
||
color: 'white',
|
||
fontSize: '20px',
|
||
fontWeight: 'bold',
|
||
marginRight: '10px'
|
||
});
|
||
|
||
// 3. Create a container to hold both selectors
|
||
const container = document.createElement('div');
|
||
container.id = 'version-lang-switchers';
|
||
Object.assign(container.style, {
|
||
display: 'flex',
|
||
alignItems: 'center',
|
||
justifyContent: 'flex-end',
|
||
width: 'auto'
|
||
});
|
||
container.appendChild(ftxuiTitle);
|
||
container.appendChild(langSelect);
|
||
container.appendChild(versionSelect);
|
||
|
||
Object.assign(container.style, {
|
||
backgroundColor: 'rgba(0, 0, 0, 0.5)',
|
||
padding: '5px 10px',
|
||
borderRadius: '8px'
|
||
});
|
||
|
||
|
||
// Replace the Doxygen project number element with our container.
|
||
projectNumber.replaceWith(container);
|
||
|
||
// Clean up the original Doxygen project number text if it still exists nearby
|
||
const parent = container.parentElement;
|
||
if (parent) {
|
||
const textNode = Array.from(parent.childNodes).find(n => n.nodeType === 3 && n.textContent.trim() !== '');
|
||
if (textNode) {
|
||
textNode.remove();
|
||
}
|
||
}
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|