mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-11-15 11:38:56 +08:00
Compare commits
23 Commits
853d87e917
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
229cae78b5 | ||
|
|
e87d5ff95a | ||
|
|
e0d98feb34 | ||
|
|
8bdf7cd701 | ||
|
|
01d2451dfd | ||
|
|
1d0913bfb9 | ||
|
|
a0ce9bf55d | ||
|
|
09e690f8ab | ||
|
|
68281ce3e8 | ||
|
|
d4fda16e20 | ||
|
|
2b9913e2eb | ||
|
|
b1bc0ff982 | ||
|
|
252ce67830 | ||
|
|
e858bf9809 | ||
|
|
e5652f11ec | ||
|
|
412d8c14e4 | ||
|
|
a3103f5cd4 | ||
|
|
8249fcb41e | ||
|
|
f21fcc1995 | ||
|
|
f7ac35ed35 | ||
|
|
fba510ec02 | ||
|
|
775ad9ce5e | ||
|
|
f5785fd3b4 |
212
.github/copilot-instructions.md
vendored
Normal file
212
.github/copilot-instructions.md
vendored
Normal file
@@ -0,0 +1,212 @@
|
||||
# FTXUI - Functional Terminal (X) User Interface
|
||||
|
||||
FTXUI is a cross-platform C++ library for terminal-based user interfaces with a functional programming approach, inspired by React.
|
||||
|
||||
**ALWAYS reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the information here.**
|
||||
|
||||
## Working Effectively
|
||||
|
||||
### Build System Setup and Commands
|
||||
- Bootstrap and build the repository:
|
||||
```bash
|
||||
# Basic build (library only) - fast
|
||||
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build build --parallel $(nproc)
|
||||
# Build time: ~30 seconds. NEVER CANCEL. Set timeout to 120+ seconds.
|
||||
|
||||
# Build with examples
|
||||
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DFTXUI_BUILD_EXAMPLES=ON
|
||||
cmake --build build --parallel $(nproc)
|
||||
# Build time: ~70 seconds. NEVER CANCEL. Set timeout to 180+ seconds.
|
||||
|
||||
# Build with examples and tests
|
||||
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DFTXUI_BUILD_EXAMPLES=ON -DFTXUI_BUILD_TESTS=ON
|
||||
cmake --build build --parallel $(nproc)
|
||||
# Build time: ~113 seconds (includes GoogleTest download). NEVER CANCEL. Set timeout to 300+ seconds.
|
||||
```
|
||||
|
||||
- Alternative build with Ninja (faster):
|
||||
```bash
|
||||
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DFTXUI_BUILD_EXAMPLES=ON
|
||||
ninja -C build
|
||||
# Build time: ~62 seconds. NEVER CANCEL. Set timeout to 180+ seconds.
|
||||
```
|
||||
|
||||
- Run unit tests:
|
||||
```bash
|
||||
# Configure with tests enabled first, then:
|
||||
cd build && ctest --output-on-failure
|
||||
# Test time: ~4 seconds (302 tests). NEVER CANCEL. Set timeout to 60+ seconds.
|
||||
```
|
||||
|
||||
### Bazel Support
|
||||
- FTXUI also supports Bazel build system
|
||||
- **WARNING**: Bazel may fail due to network connectivity issues in sandboxed environments
|
||||
- If Bazel is available:
|
||||
```bash
|
||||
bazel build //... # Build everything
|
||||
bazel test //... # Run tests
|
||||
```
|
||||
|
||||
## Validation
|
||||
|
||||
### Manual Testing After Changes
|
||||
- **ALWAYS manually validate changes by building and running examples after making code modifications**
|
||||
- Run example applications to verify functionality:
|
||||
```bash
|
||||
# Build an example first
|
||||
cmake --build build --target ftxui_example_border
|
||||
|
||||
# Run examples (they are interactive, use timeout to terminate)
|
||||
timeout 2s build/examples/dom/ftxui_example_border
|
||||
timeout 2s build/examples/dom/ftxui_example_color_gallery
|
||||
timeout 2s build/examples/component/ftxui_example_button
|
||||
```
|
||||
- Examples should produce visual terminal output with borders, colors, and UI components
|
||||
- **CRITICAL**: Always run at least one DOM example and one Component example to verify both modules work
|
||||
|
||||
### Code Quality and Formatting
|
||||
- Always run formatting before committing:
|
||||
```bash
|
||||
./tools/format.sh
|
||||
# Format time: ~7 seconds. NEVER CANCEL. Set timeout to 60+ seconds.
|
||||
```
|
||||
- The format script adds license headers and runs clang-format on all source files
|
||||
- **Required**: Run formatting or the CI (.github/workflows/build.yaml) will fail
|
||||
|
||||
### Build Validation Requirements
|
||||
- ALWAYS build with both `-DFTXUI_BUILD_EXAMPLES=ON` and `-DFTXUI_BUILD_TESTS=ON` when making changes
|
||||
- Run the complete test suite with `ctest --output-on-failure`
|
||||
- All 302 tests must pass
|
||||
- **Scenario Testing**: Run at least these validation scenarios:
|
||||
1. Build library only (basic validation)
|
||||
2. Build with examples and run 2-3 different examples
|
||||
3. Build with tests and run complete test suite
|
||||
4. Run formatting tool to ensure code style compliance
|
||||
|
||||
## Project Structure
|
||||
|
||||
### Key Directories
|
||||
```
|
||||
/home/runner/work/FTXUI/FTXUI/
|
||||
├── include/ftxui/ # Public header files
|
||||
│ ├── component/ # Interactive component headers
|
||||
│ ├── dom/ # DOM element headers
|
||||
│ ├── screen/ # Screen and rendering headers
|
||||
│ └── util/ # Utility headers
|
||||
├── src/ftxui/ # Implementation files
|
||||
│ ├── component/ # Interactive components (buttons, menus, etc.)
|
||||
│ ├── dom/ # DOM elements (layout, styling, text)
|
||||
│ ├── screen/ # Screen rendering and terminal handling
|
||||
│ └── util/ # Utilities
|
||||
├── examples/ # Example applications
|
||||
│ ├── component/ # Interactive component examples
|
||||
│ └── dom/ # DOM element examples
|
||||
├── cmake/ # CMake configuration files
|
||||
├── tools/ # Development tools (formatting, etc.)
|
||||
└── .github/workflows/ # CI/CD configuration
|
||||
```
|
||||
|
||||
### Core Library Modules
|
||||
FTXUI is organized into three main modules that depend on each other:
|
||||
```
|
||||
┌component──┐ (Interactive UI components)
|
||||
│┌dom──────┐│ (Layout and styling elements)
|
||||
││┌screen─┐││ (Terminal rendering and input)
|
||||
└┴┴───────┴┴┘
|
||||
```
|
||||
|
||||
1. **screen**: Low-level terminal handling, colors, pixels, input
|
||||
2. **dom**: Layout elements (hbox, vbox, text, borders, etc.)
|
||||
3. **component**: Interactive components (buttons, menus, input fields)
|
||||
|
||||
### CMake Build Options
|
||||
| Option | Description | Default |
|
||||
|-----------------------------------|----------------------------------|---------|
|
||||
| FTXUI_BUILD_EXAMPLES | Build example applications | OFF |
|
||||
| FTXUI_BUILD_DOCS | Build documentation | OFF |
|
||||
| FTXUI_BUILD_TESTS | Build and enable tests | OFF |
|
||||
| FTXUI_BUILD_MODULES | Build C++20 modules | OFF |
|
||||
| FTXUI_ENABLE_INSTALL | Generate install targets | ON |
|
||||
| FTXUI_MICROSOFT_TERMINAL_FALLBACK | Windows terminal compatibility | ON/OFF |
|
||||
|
||||
## Common Tasks
|
||||
|
||||
### Building Examples
|
||||
```bash
|
||||
# Build specific examples
|
||||
cmake --build build --target ftxui_example_border
|
||||
cmake --build build --target ftxui_example_button
|
||||
cmake --build build --target ftxui_example_menu
|
||||
|
||||
# List all available examples
|
||||
find build -name "ftxui_example_*" -type f
|
||||
```
|
||||
|
||||
### Running Tests
|
||||
```bash
|
||||
# Run all tests
|
||||
cd build && ctest
|
||||
|
||||
# Run tests with verbose output
|
||||
cd build && ctest --verbose
|
||||
|
||||
# Run specific test pattern
|
||||
cd build && ctest -R "Button" --verbose
|
||||
```
|
||||
|
||||
### Working with Source Code
|
||||
- **Component Development**: Modify files in `src/ftxui/component/` for interactive elements
|
||||
- **DOM Development**: Modify files in `src/ftxui/dom/` for layout and styling
|
||||
- **Screen Development**: Modify files in `src/ftxui/screen/` for terminal rendering
|
||||
- **Adding Examples**: Add new `.cpp` files in `examples/component/` or `examples/dom/`
|
||||
- **Header Files**: Public APIs are in `include/ftxui/[module]/`
|
||||
|
||||
### Integration Patterns
|
||||
When adding FTXUI to a project, use CMake FetchContent (recommended):
|
||||
```cmake
|
||||
include(FetchContent)
|
||||
FetchContent_Declare(ftxui
|
||||
GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui
|
||||
GIT_TAG v6.1.9
|
||||
)
|
||||
FetchContent_MakeAvailable(ftxui)
|
||||
|
||||
target_link_libraries(your_target PRIVATE
|
||||
ftxui::component # For interactive components
|
||||
ftxui::dom # For layout elements
|
||||
ftxui::screen # For basic rendering
|
||||
)
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build Issues
|
||||
- If CMake configuration fails, ensure C++20 support: `cmake --version` (need 3.12+)
|
||||
- If Ninja build fails, fall back to Make: `cmake -S . -B build` (without `-G Ninja`)
|
||||
- If tests fail to build, GoogleTest download might have failed - check network connectivity
|
||||
- Build artifacts are in `build/` directory - delete with `rm -rf build` to clean
|
||||
|
||||
### Example Issues
|
||||
- Examples are interactive terminal applications - use `timeout` to terminate them
|
||||
- If examples don't display correctly, terminal might not support colors/Unicode
|
||||
- Examples require terminal size of at least 80x24 for proper display
|
||||
|
||||
### Formatting Issues
|
||||
- Format script requires clang-format to be installed
|
||||
- If format script fails, check that source files are not read-only
|
||||
- Format script modifies files in-place - commit changes afterwards
|
||||
|
||||
## Critical Reminders
|
||||
|
||||
- **NEVER CANCEL long-running builds** - they may take 2-3 minutes
|
||||
- **ALWAYS run the formatting tool** before committing changes
|
||||
- **ALWAYS build and test examples** when making component/dom changes
|
||||
- **SET APPROPRIATE TIMEOUTS**: 300+ seconds for builds, 60+ seconds for tests
|
||||
- **BUILD TIMING EXPECTATIONS**:
|
||||
- Basic library: ~30 seconds
|
||||
- With examples: ~70 seconds
|
||||
- With examples + tests: ~113 seconds (first time, includes GoogleTest download)
|
||||
- Subsequent builds: ~60-70 seconds
|
||||
- Tests execution: ~4 seconds
|
||||
- Formatting: ~7 seconds
|
||||
16
.github/workflows/documentation.yaml
vendored
16
.github/workflows/documentation.yaml
vendored
@@ -12,6 +12,10 @@ jobs:
|
||||
steps:
|
||||
- name: "Checkout repository"
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0 # Need full history.
|
||||
fetch-tags: true # Need tags.
|
||||
|
||||
|
||||
- name: "Install cmake"
|
||||
uses: lukka/get-cmake@latest
|
||||
@@ -30,7 +34,12 @@ jobs:
|
||||
sudo apt-get install graphviz;
|
||||
|
||||
- name: "Build documentation"
|
||||
run: |
|
||||
python3 ./tools/build_multiversion_doc.py
|
||||
|
||||
- name: "Build examples"
|
||||
run: >
|
||||
mkdir -p multiversion_docs/main/examples;
|
||||
mkdir build;
|
||||
cd build;
|
||||
emcmake cmake ..
|
||||
@@ -41,8 +50,7 @@ jobs:
|
||||
-DFTXUI_BUILD_TESTS_FUZZER=OFF
|
||||
-DFTXUI_ENABLE_INSTALL=OFF
|
||||
-DFTXUI_DEV_WARNINGS=OFF;
|
||||
cmake --build . --target doc;
|
||||
cmake --build . ;
|
||||
cmake --build .;
|
||||
rsync -amv
|
||||
--include='*/'
|
||||
--include='*.html'
|
||||
@@ -52,13 +60,13 @@ jobs:
|
||||
--include='*.wasm'
|
||||
--exclude='*'
|
||||
examples
|
||||
doc/doxygen/html;
|
||||
../multiversion_docs/
|
||||
|
||||
- name: "Deploy"
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: build/doc/doxygen/html/
|
||||
publish_dir: multiversion_docs
|
||||
enable_jekyll: false
|
||||
allow_empty_commit: false
|
||||
force_orphan: true
|
||||
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -28,6 +28,7 @@ out/
|
||||
# .github directory:
|
||||
!.github/**/*.yaml
|
||||
!.github/**/*.yml
|
||||
!.github/**/*.md
|
||||
|
||||
# cmake directory:
|
||||
!cmake/**/*.in
|
||||
@@ -44,6 +45,7 @@ out/
|
||||
!doc/**/*.html
|
||||
!doc/**/*.xml
|
||||
!doc/**/*.md
|
||||
!doc/*.md
|
||||
|
||||
# examples directory:
|
||||
!examples/**/*.cpp
|
||||
@@ -69,4 +71,6 @@ out/
|
||||
|
||||
# tools directory:
|
||||
!tools/**/*.sh
|
||||
!tools/**/*.py
|
||||
!tools/**/*.cpp
|
||||
build/
|
||||
|
||||
11
CHANGELOG.md
11
CHANGELOG.md
@@ -27,11 +27,22 @@ Next
|
||||
- Remove dependency on 'pthread'.
|
||||
|
||||
### Component
|
||||
- Feature: POSIX Piped Input Handling.
|
||||
- Allows FTXUI applications to read data from stdin (when piped) while still receiving keyboard input from the terminal.
|
||||
- Enabled by default.
|
||||
- Can be disabled using `ScreenInteractive::HandlePipedInput(false)`.
|
||||
- Only available on Linux and macOS.
|
||||
Thanks @HarryPehkonen for PR #1094.
|
||||
- Fix ScreenInteractive::FixedSize screen stomps on the preceding terminal
|
||||
output. Thanks @zozowell in #1064.
|
||||
- Fix vertical `ftxui::Slider`. The "up" key was previously decreasing the
|
||||
value. Thanks @its-pablo in #1093 for reporting the issue.
|
||||
|
||||
### Dom
|
||||
- Fix integer overflow in `ComputeShrinkHard`. Thanks @its-pablo in #1137 for
|
||||
reporting and fixing the issue.
|
||||
- Add specialization for `vbox/hbox/dbox` to allow a container of Element as
|
||||
as input. Thanks @nbusser in #1117.
|
||||
|
||||
6.1.9 (2025-05-07)
|
||||
------------
|
||||
|
||||
10
README.md
10
README.md
@@ -364,6 +364,8 @@ Feel free to add your projects here:
|
||||
- [openJuice](https://github.com/mikomikotaishi/openJuice)
|
||||
- [SHOOT!](https://github.com/ShingZhanho/ENGG1340-Project-25Spring)
|
||||
- [VerifySN (Fast Hash Tool)](https://github.com/d06i/verifySN)
|
||||
- [tic-tac-toe](https://github.com/birland/tic-tac-toe)
|
||||
- [typing-speed-test](https://github.com/ymcx/typing-speed-test)
|
||||
|
||||
### [cpp-best-practices/game_jam](https://github.com/cpp-best-practices/game_jam)
|
||||
|
||||
@@ -380,6 +382,8 @@ Several games using the FTXUI have been made during the Game Jam:
|
||||
- [smoothlife](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/smoothlife.md)
|
||||
- [Consu](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/consu.md)
|
||||
|
||||
|
||||
|
||||
## Build using CMake
|
||||
|
||||
It is **highly** recommended to use CMake FetchContent to depend on FTXUI so you may specify which commit you would like to depend on.
|
||||
@@ -415,9 +419,9 @@ cc_binary(
|
||||
name = "your_target",
|
||||
srcs = ["your_source.cc"],
|
||||
deps = [
|
||||
"@ftxui//:ftxui_component",
|
||||
"@ftxui//:ftxui_dom",
|
||||
"@ftxui//:ftxui_screen",
|
||||
"@ftxui//:component",
|
||||
"@ftxui//:dom",
|
||||
"@ftxui//:screen",
|
||||
],
|
||||
)
|
||||
```
|
||||
|
||||
@@ -13,7 +13,7 @@ include(FetchContent)
|
||||
|
||||
FetchContent_Declare(googletest
|
||||
GIT_REPOSITORY "https://github.com/google/googletest"
|
||||
GIT_TAG 23ef29555ef4789f555f1ba8c51b4c52975f0907
|
||||
GIT_TAG 52eb8108c5bdec04579160ae17225d66034bd723 # v1.17.0
|
||||
GIT_PROGRESS TRUE
|
||||
)
|
||||
|
||||
|
||||
@@ -11,6 +11,9 @@ include(CMakePackageConfigHelpers)
|
||||
install(
|
||||
TARGETS screen dom component
|
||||
EXPORT ftxui-targets
|
||||
ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}"
|
||||
LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
|
||||
RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}"
|
||||
)
|
||||
|
||||
install(
|
||||
|
||||
@@ -4,15 +4,15 @@
|
||||
> [!WARNING]
|
||||
> This feature is still in development, and the API may change in future releases.
|
||||
> Your contribution is needed to help us improve the compatibility and usability
|
||||
> of C++20 modules in FTXUI. If you encounter any issues or have suggestions,
|
||||
> of C++ modules in FTXUI. If you encounter any issues or have suggestions,
|
||||
> please open an issue.
|
||||
|
||||
FTXUI experimentally supports
|
||||
[C++20 modules](https://en.cppreference.com/w/cpp/language/modules) to reduce
|
||||
compilation times and improve code organization. Each header has a
|
||||
corresponding module.
|
||||
compilation times and improve code organization. Each part of the library has a
|
||||
corresponding module, split into partitions per each header.
|
||||
|
||||
Use the FTXUI_BUILD_MODULES option to build the FTXUI project itself to provide C++ 20 modules,
|
||||
Use the FTXUI_BUILD_MODULES option to build the FTXUI project itself to provide C++20 modules,
|
||||
for example with CMake and Ninja:
|
||||
|
||||
```sh
|
||||
@@ -25,7 +25,7 @@ ninja
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> To use modules, you need a C++20 compatible compiler, CMake version 3.20 or
|
||||
> To use modules, you need a C++≥20 compatible compiler, CMake version 3.20 or
|
||||
> higher, and use a compatible generator like Ninja. Note that Makefile
|
||||
> generators **do not support modules**.
|
||||
|
||||
@@ -34,9 +34,12 @@ Then, in your own code you can consume the modules and code as normal:
|
||||
```cpp
|
||||
import ftxui;
|
||||
|
||||
using ftxui::Button;
|
||||
using ftxui::ScreenInteractive;
|
||||
|
||||
int main() {
|
||||
auto screen = ftxui::ScreenInteractive::TerminalOutput();
|
||||
auto button = ftxui::Button("Click me", screen.QuitClosure());
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
auto button = Button("Click me", screen.QuitClosure());
|
||||
screen.Loop(button);
|
||||
return 0;
|
||||
}
|
||||
@@ -70,38 +73,6 @@ are available:
|
||||
|
||||
- `ftxui`
|
||||
- `ftxui.component`
|
||||
- `ftxui.component.Animation`
|
||||
- `ftxui.component.CapturedMouse`
|
||||
- `ftxui.component.Component`
|
||||
- `ftxui.component.ComponentBase`
|
||||
- `ftxui.component.ComponentOptions`
|
||||
- `ftxui.component.Event`
|
||||
- `ftxui.component.Loop`
|
||||
- `ftxui.component.Mouse`
|
||||
- `ftxui.component.Receiver`
|
||||
- `ftxui.component.ScreenInteractive`
|
||||
- `ftxui.component.Task`
|
||||
- `ftxui.dom`
|
||||
- `ftxui.dom.Canvas`
|
||||
- `ftxui.dom.Deprecated`
|
||||
- `ftxui.dom.Direction`
|
||||
- `ftxui.dom.Elements`
|
||||
- `ftxui.dom.FlexboxConfig`
|
||||
- `ftxui.dom.LinearGradient`
|
||||
- `ftxui.dom.Node`
|
||||
- `ftxui.dom.Requirement`
|
||||
- `ftxui.dom.Selection`
|
||||
- `ftxui.dom.Table`
|
||||
- `ftxui.screen`
|
||||
- `ftxui.screen.Box`
|
||||
- `ftxui.screen.Color`
|
||||
- `ftxui.screen.ColorInfo`
|
||||
- `ftxui.screen.Deprecated`
|
||||
- `ftxui.screen.Image`
|
||||
- `ftxui.screen.Pixel`
|
||||
- `ftxui.screen.Screen`
|
||||
- `ftxui.screen.String`
|
||||
- `ftxui.screen.Terminal`
|
||||
- `ftxui.util`
|
||||
- `ftxui.util.AutoReset`
|
||||
- `ftxui.util.Ref`
|
||||
- `ftxui.dom`
|
||||
- `ftxui.screen`
|
||||
- `ftxui.util`
|
||||
|
||||
@@ -2,16 +2,9 @@
|
||||
<!-- start footer part -->
|
||||
<!--BEGIN GENERATE_TREEVIEW-->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
$navpath
|
||||
<li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--END GENERATE_TREEVIEW-->
|
||||
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
|
||||
</small></address>
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -1,19 +1,99 @@
|
||||
@page installation_conan Conan
|
||||
@tableofcontents
|
||||
|
||||
Unofficial recipe for FTXUI exists on Conan Center:
|
||||
<https://conan.io/center/recipes/ftxui>
|
||||
FTXUI can be easily obtained and integrated into your project using the Conan package manager.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
First, ensure that Conan is installed on your system. If not, you can install it via pip:
|
||||
|
||||
```powershell
|
||||
pip install conan
|
||||
```
|
||||
Conan often works in tandem with CMake, so you will need to have CMake installed as well. Once you have confirmed both Conan and CMake are installed, create a project directory, for example, `ftxui-demo`:
|
||||
|
||||
```powershell
|
||||
mkdir C:\ftxui-demo
|
||||
cd C:\ftxui-demo
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
After ensuring your environment is set up correctly, create a Conan configuration file `conanfile.txt`. This file is used to declare your project's dependencies. The community-maintained package for FTXUI can be found on [Conan Center](https://conan.io/center/recipes/ftxui).
|
||||
|
||||
> [!note]
|
||||
> This is an unofficial recipe. That means it is not maintained by the FTXUI
|
||||
> team, but by the community. The package maintainers seems to actively update
|
||||
> the package to the latest version. Thanks to the maintainers for their work!
|
||||
> This is an unofficial build script. This means it is not maintained by the FTXUI
|
||||
> team but by the community. The package maintainer appears to actively update it
|
||||
> to the latest releases. Many thanks to the maintainer for their work!
|
||||
|
||||
@todo If you are familiar with the process, please consider adding an "official" build script to Conan Center.
|
||||
This could be a GitHub Action that automatically updates Conan Center upon new releases.
|
||||
|
||||
@todo Add instructions on how to use the conan recipe.
|
||||
```ini
|
||||
[requires]
|
||||
ftxui/6.0.2
|
||||
|
||||
@todo Please consider adding an "official" recipe to Conan Center if know how.
|
||||
It could be a github action that will automatically update the conan center
|
||||
when a new release is made.
|
||||
[generators]
|
||||
CMakeDeps
|
||||
CMakeToolchain
|
||||
|
||||
[layout]
|
||||
cmake_layout
|
||||
```
|
||||
|
||||
## Install Dependencies and Build
|
||||
|
||||
Once configured, run the following command to install FTXUI and its dependencies:
|
||||
|
||||
```powershell
|
||||
conan install . --output-folder=build --build=missing
|
||||
```
|
||||
|
||||
This will download and install `ftxui/6.0.2` along with all its dependencies from Conan's remote repositories.
|
||||
|
||||
After the installation completes, you can test it by creating a `demo.cpp` file in your project directory:
|
||||
|
||||
```cpp
|
||||
#include <ftxui/screen/screen.hpp>
|
||||
#include <ftxui/dom/elements.hpp>
|
||||
#include <iostream>
|
||||
|
||||
int main() {
|
||||
using namespace ftxui;
|
||||
auto document = hbox({
|
||||
text(" Hello "),
|
||||
text("FTXUI ") | bold | color(Color::Red),
|
||||
text(" world! ")
|
||||
});
|
||||
auto screen = Screen::Create(Dimension::Full(), Dimension::Fit(document));
|
||||
Render(screen, document);
|
||||
std::cout << screen.ToString() << std::endl;
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
If the test is successful, you can then create a `CMakeLists.txt` file in the project directory:
|
||||
|
||||
```cmake
|
||||
cmake_minimum_required(VERSION 3.20)
|
||||
project(ftxui-demo)
|
||||
|
||||
# Set the C++ standard
|
||||
set(CMAKE_CXX_STANDARD 20)
|
||||
|
||||
# Find the FTXUI package installed via Conan
|
||||
find_package(ftxui CONFIG REQUIRED)
|
||||
|
||||
# Create the executable
|
||||
add_executable(demo demo.cpp)
|
||||
|
||||
# Link the executable to the FTXUI library
|
||||
target_link_libraries(demo PRIVATE ftxui::component)
|
||||
```
|
||||
|
||||
@todo 考虑到中国多数地区使用Conan很有可能遇到各种网络问题,我想做一个定制的版本说明,但是我对conan的了解有限再加上没有找到合适的资料,因此这个计划短暂的被搁置了,如果您知道方法,欢迎在[中文版本](xiaoditx.girhub.io/public/docs/ftxui%E4%B8%AD%E6%96%87%E7%BF%BB%E8%AF%91/installation/conan/)的下方留下评论以提醒我
|
||||
|
||||
---
|
||||
|
||||
<div class="section_buttons">
|
||||
|
||||
|
||||
58
doc/posix_pipe.md
Normal file
58
doc/posix_pipe.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# POSIX Piped Input in FTXUI
|
||||
|
||||
> [!WARNING]
|
||||
> This feature works only on Linux and macOS. It is not supported on
|
||||
> Windows and WebAssembly.
|
||||
|
||||
## What is a POSIX Pipe?
|
||||
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
|
||||
Imagine you want to list files and then filter them interactively.
|
||||
|
||||
- `ls`: Lists files.
|
||||
- `interactive_grep`: An FTXUI application that filters text and lets you type.
|
||||
|
||||
You can connect them with a pipe (`|`):
|
||||
|
||||
```bash
|
||||
ls -l | interactive_grep
|
||||
```
|
||||
|
||||
Here's what happens:
|
||||
1. `ls -l` lists files with details.
|
||||
2. The `|` sends this list directly to `interactive_grep`.
|
||||
3. `interactive_grep` 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 `ls`.
|
||||
|
||||
## How FTXUI Handles Piped Input
|
||||
|
||||
Now that you understand what a POSIX pipe is, let's look at how FTXUI uses them.
|
||||
|
||||
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.
|
||||
|
||||
Normally, FTXUI applications receive all input from `stdin`. However, when FTXUI detects that `stdin` 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 `/dev/tty`. This ensures that your application can still receive user input even while processing piped data.
|
||||
|
||||
This feature is **turned on by default**.
|
||||
|
||||
If your FTXUI application needs to read piped data and also respond to keyboard input, you typically don't need to do anything special:
|
||||
|
||||
```cpp
|
||||
auto screen = ScreenInteractive::Fullscreen();
|
||||
// screen.HandlePipedInput(true); // This is enabled by default
|
||||
screen.Loop(component);
|
||||
```
|
||||
|
||||
|
||||
## Turning Off Piped Input
|
||||
|
||||
If you don't need this feature, or if it conflicts with your custom input handling, you can turn it off.
|
||||
|
||||
To disable it, call `HandlePipedInput(false)` before starting your application's main loop:
|
||||
|
||||
```cpp
|
||||
auto screen = ScreenInteractive::Fullscreen();
|
||||
screen.HandlePipedInput(false); // Turn off piped input handling
|
||||
screen.Loop(component);
|
||||
```
|
||||
@@ -39,6 +39,7 @@ example(radiobox)
|
||||
example(radiobox_in_frame)
|
||||
example(renderer)
|
||||
example(resizable_split)
|
||||
example(resizable_split_clamp)
|
||||
example(scrollbar)
|
||||
example(selection)
|
||||
example(slider)
|
||||
|
||||
@@ -34,8 +34,8 @@ int main() {
|
||||
int value = 50;
|
||||
|
||||
// clang-format off
|
||||
auto btn_dec_01 = Button("-1", [&] { value += 1; }, Style());
|
||||
auto btn_inc_01 = Button("+1", [&] { value -= 1; }, Style());
|
||||
auto btn_dec_01 = Button("-1", [&] { value -= 1; }, Style());
|
||||
auto btn_inc_01 = Button("+1", [&] { value += 1; }, Style());
|
||||
auto btn_dec_10 = Button("-10", [&] { value -= 10; }, Style());
|
||||
auto btn_inc_10 = Button("+10", [&] { value += 10; }, Style());
|
||||
// clang-format on
|
||||
|
||||
@@ -3,7 +3,6 @@
|
||||
// the LICENSE file.
|
||||
#include <memory> // for shared_ptr, allocator, __shared_ptr_access
|
||||
|
||||
#include "ftxui/component/captured_mouse.hpp" // for ftxui
|
||||
#include "ftxui/component/component.hpp" // for Renderer, ResizableSplitBottom, ResizableSplitLeft, ResizableSplitRight, ResizableSplitTop
|
||||
#include "ftxui/component/component_base.hpp" // for ComponentBase
|
||||
#include "ftxui/component/screen_interactive.hpp" // for ScreenInteractive
|
||||
@@ -14,17 +13,24 @@ using namespace ftxui;
|
||||
int main() {
|
||||
auto screen = ScreenInteractive::Fullscreen();
|
||||
|
||||
auto middle = Renderer([] { return text("middle") | center; });
|
||||
auto left = Renderer([] { return text("Left") | center; });
|
||||
auto right = Renderer([] { return text("right") | center; });
|
||||
auto top = Renderer([] { return text("top") | center; });
|
||||
auto bottom = Renderer([] { return text("bottom") | center; });
|
||||
|
||||
// State:
|
||||
int left_size = 20;
|
||||
int right_size = 20;
|
||||
int top_size = 10;
|
||||
int bottom_size = 10;
|
||||
|
||||
// Renderers:
|
||||
auto RendererInfo = [](const std::string& name, int* size) {
|
||||
return Renderer([name, size] {
|
||||
return text(name + ": " + std::to_string(*size)) | center;
|
||||
});
|
||||
};
|
||||
auto middle = Renderer([] { return text("Middle") | center; });
|
||||
auto left = RendererInfo("Left", &left_size);
|
||||
auto right = RendererInfo("Right", &right_size);
|
||||
auto top = RendererInfo("Top", &top_size);
|
||||
auto bottom = RendererInfo("Bottom", &bottom_size);
|
||||
|
||||
auto container = middle;
|
||||
container = ResizableSplitLeft(left, container, &left_size);
|
||||
container = ResizableSplitRight(right, container, &right_size);
|
||||
|
||||
43
examples/component/resizable_split_clamp.cpp
Normal file
43
examples/component/resizable_split_clamp.cpp
Normal file
@@ -0,0 +1,43 @@
|
||||
// Copyright 2025 Arthur Sonzogni. All rights reserved.
|
||||
// Use of this source code is governed by the MIT license that can be found in
|
||||
// the LICENSE file.
|
||||
#include <memory> // for shared_ptr, allocator, __shared_ptr_access
|
||||
|
||||
#include "ftxui/component/component.hpp" // for Renderer, ResizableSplitBottom, ResizableSplitLeft, ResizableSplitRight, ResizableSplitTop
|
||||
#include "ftxui/component/component_base.hpp" // for ComponentBase
|
||||
#include "ftxui/component/screen_interactive.hpp" // for ScreenInteractive
|
||||
#include "ftxui/dom/elements.hpp" // for Element, operator|, text, center, border
|
||||
|
||||
using namespace ftxui;
|
||||
|
||||
int main() {
|
||||
auto screen = ScreenInteractive::Fullscreen();
|
||||
|
||||
// State:
|
||||
int size = 40;
|
||||
int size_min = 10;
|
||||
int size_max = 80;
|
||||
|
||||
// Renderers:
|
||||
auto split = ResizableSplit({
|
||||
.main = Renderer([] { return text("Left") | center; }),
|
||||
.back = Renderer([] { return text("Right") | center; }),
|
||||
.direction = Direction::Left,
|
||||
.main_size = &size,
|
||||
.min = &size_min,
|
||||
.max = &size_max,
|
||||
});
|
||||
|
||||
auto renderer = Renderer(split, [&] {
|
||||
return window(text("Drag the separator with the mouse"),
|
||||
vbox({
|
||||
text("Min: " + std::to_string(size_min)),
|
||||
text("Max: " + std::to_string(size_max)),
|
||||
text("Size: " + std::to_string(size)),
|
||||
separator(),
|
||||
split->Render() | flex,
|
||||
}));
|
||||
});
|
||||
|
||||
screen.Loop(renderer);
|
||||
}
|
||||
@@ -11,6 +11,7 @@
|
||||
#include <ftxui/util/ref.hpp> // for Ref, ConstRef, StringRef
|
||||
#include <ftxui/util/warn_windows_macro.hpp>
|
||||
#include <functional> // for function
|
||||
#include <limits> // for numeric_limits
|
||||
#include <string> // for string
|
||||
|
||||
#include "ftxui/component/component_base.hpp" // for Component
|
||||
@@ -217,6 +218,10 @@ struct ResizableSplitOption {
|
||||
(direction() == Direction::Left || direction() == Direction::Right) ? 20
|
||||
: 10;
|
||||
std::function<Element()> separator_func = [] { return ::ftxui::separator(); };
|
||||
|
||||
// Constraints on main_size:
|
||||
Ref<int> min = 0;
|
||||
Ref<int> max = std::numeric_limits<int>::max();
|
||||
};
|
||||
|
||||
// @brief Option for the `Slider` component.
|
||||
|
||||
@@ -4,10 +4,10 @@
|
||||
#ifndef FTXUI_COMPONENT_RECEIVER_HPP_
|
||||
#define FTXUI_COMPONENT_RECEIVER_HPP_
|
||||
|
||||
#include <ftxui/util/warn_windows_macro.hpp>
|
||||
#include <algorithm> // for copy, max
|
||||
#include <atomic> // for atomic, __atomic_base
|
||||
#include <condition_variable> // for condition_variable
|
||||
#include <ftxui/util/warn_windows_macro.hpp>
|
||||
#include <memory> // for unique_ptr, make_unique
|
||||
#include <mutex> // for mutex, unique_lock
|
||||
#include <queue> // for queue
|
||||
|
||||
@@ -43,10 +43,11 @@ class ScreenInteractive : public Screen {
|
||||
static ScreenInteractive TerminalOutput();
|
||||
|
||||
// Destructor.
|
||||
~ScreenInteractive();
|
||||
~ScreenInteractive() override;
|
||||
|
||||
// Options. Must be called before Loop().
|
||||
void TrackMouse(bool enable = true);
|
||||
void HandlePipedInput(bool enable = true);
|
||||
|
||||
// Return the currently active screen, nullptr if none.
|
||||
static ScreenInteractive* Active();
|
||||
@@ -100,6 +101,8 @@ class ScreenInteractive : public Screen {
|
||||
void Draw(Component component);
|
||||
void ResetCursorPosition();
|
||||
|
||||
void InstallPipedInputHandling();
|
||||
|
||||
void Signal(int signal);
|
||||
|
||||
void FetchTerminalEvents();
|
||||
@@ -117,6 +120,7 @@ class ScreenInteractive : public Screen {
|
||||
int dimx,
|
||||
int dimy,
|
||||
bool use_alternative_screen);
|
||||
|
||||
const Dimension dimension_;
|
||||
const bool use_alternative_screen_;
|
||||
|
||||
@@ -141,6 +145,11 @@ class ScreenInteractive : public Screen {
|
||||
bool force_handle_ctrl_c_ = true;
|
||||
bool force_handle_ctrl_z_ = true;
|
||||
|
||||
// Piped input handling state (POSIX only)
|
||||
bool handle_piped_input_ = true;
|
||||
// File descriptor for /dev/tty, used for piped input handling.
|
||||
int tty_fd_ = -1;
|
||||
|
||||
// The style of the cursor to restore on exit.
|
||||
int cursor_reset_shape_ = 1;
|
||||
|
||||
|
||||
@@ -5,25 +5,18 @@
|
||||
#define FTXUI_DOM_TAKE_ANY_ARGS_HPP
|
||||
|
||||
// IWYU pragma: private, include "ftxui/dom/elements.hpp"
|
||||
#include <deque>
|
||||
#include <ftxui/dom/node.hpp>
|
||||
#include <queue>
|
||||
#include <stack>
|
||||
#include <vector>
|
||||
|
||||
namespace ftxui {
|
||||
|
||||
template <class T>
|
||||
void Merge(Elements& /*container*/, T /*element*/) {}
|
||||
|
||||
template <>
|
||||
inline void Merge(Elements& container, Element element) {
|
||||
container.push_back(std::move(element));
|
||||
}
|
||||
|
||||
template <>
|
||||
inline void Merge(Elements& container, Elements elements) {
|
||||
for (auto& element : elements) {
|
||||
container.push_back(std::move(element));
|
||||
}
|
||||
}
|
||||
|
||||
// Turn a set of arguments into a vector.
|
||||
template <class... Args>
|
||||
Elements unpack(Args... args) {
|
||||
@@ -32,11 +25,50 @@ Elements unpack(Args... args) {
|
||||
return vec;
|
||||
}
|
||||
|
||||
// Make |container| able to take any number of argments.
|
||||
// Make |container| able to take any number of arguments.
|
||||
#define TAKE_ANY_ARGS(container) \
|
||||
inline Element container(Element child) { \
|
||||
return container(unpack(std::move(child))); \
|
||||
} \
|
||||
\
|
||||
template <class... Args> \
|
||||
Element container(Args... children) { \
|
||||
inline Element container(Args... children) { \
|
||||
return container(unpack(std::forward<Args>(children)...)); \
|
||||
} \
|
||||
\
|
||||
template <class Container> \
|
||||
inline Element container(Container&& children) { \
|
||||
Elements elements; \
|
||||
for (auto& child : children) { \
|
||||
elements.push_back(std::move(child)); \
|
||||
} \
|
||||
return container(std::move(elements)); \
|
||||
} \
|
||||
template <> \
|
||||
inline Element container(std::stack<Element>&& children) { \
|
||||
Elements elements; \
|
||||
while (!children.empty()) { \
|
||||
elements.push_back(std::move(children.top())); \
|
||||
children.pop(); \
|
||||
} \
|
||||
return container(std::move(elements)); \
|
||||
} \
|
||||
template <> \
|
||||
inline Element container(std::queue<Element>&& children) { \
|
||||
Elements elements; \
|
||||
while (!children.empty()) { \
|
||||
elements.push_back(std::move(children.front())); \
|
||||
children.pop(); \
|
||||
} \
|
||||
return container(std::move(elements)); \
|
||||
} \
|
||||
template <> \
|
||||
inline Element container(std::deque<Element>&& children) { \
|
||||
Elements elements; \
|
||||
for (auto& child : children) { \
|
||||
elements.push_back(std::move(child)); \
|
||||
} \
|
||||
return container(std::move(elements)); \
|
||||
}
|
||||
|
||||
TAKE_ANY_ARGS(vbox)
|
||||
|
||||
@@ -60,7 +60,7 @@ class Screen : public Image {
|
||||
BarBlinking = 5,
|
||||
Bar = 6,
|
||||
};
|
||||
Shape shape;
|
||||
Shape shape = Hidden;
|
||||
};
|
||||
|
||||
Cursor cursor() const { return cursor_; }
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
|
||||
export module ftxui.component;
|
||||
|
||||
export import ftxui.component.animation;
|
||||
export import ftxui.component.captured_mouse;
|
||||
export import ftxui.component.component;
|
||||
export import ftxui.component.component_base;
|
||||
export import ftxui.component.component_options;
|
||||
export import ftxui.component.event;
|
||||
export import ftxui.component.loop;
|
||||
export import ftxui.component.mouse;
|
||||
export import ftxui.component.receiver;
|
||||
export import ftxui.component.screen_interactive;
|
||||
export import ftxui.component.task;
|
||||
export import :Animation;
|
||||
export import :CapturedMouse;
|
||||
export import :Component;
|
||||
export import :ComponentBase;
|
||||
export import :ComponentOptions;
|
||||
export import :Event;
|
||||
export import :Loop;
|
||||
export import :Mouse;
|
||||
export import :Receiver;
|
||||
export import :ScreenInteractive;
|
||||
export import :Task;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/// @module ftxui.component.animation
|
||||
/// @module ftxui.component:Animation
|
||||
/// @brief C++20 module interface for the Animation namespace of the Component module.
|
||||
///
|
||||
|
||||
@@ -6,7 +6,7 @@ module;
|
||||
|
||||
#include <ftxui/component/animation.hpp>
|
||||
|
||||
export module ftxui.component.animation;
|
||||
export module ftxui.component:Animation;
|
||||
|
||||
/**
|
||||
* @namespace ftxui::animation
|
||||
@@ -23,7 +23,7 @@ export namespace ftxui::animation {
|
||||
|
||||
/**
|
||||
* @namespace easing
|
||||
* @brief The FTXUI sf::animation::easing:: namespace
|
||||
* @brief The FTXUI ftxui::animation::easing:: namespace
|
||||
*/
|
||||
namespace easing {
|
||||
using ftxui::animation::easing::Function;
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.captured_mouse
|
||||
/// @module ftxui.component.CapturedMouse
|
||||
/// @brief Module file for the CapturedMouseInterface class of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/captured_mouse.hpp>
|
||||
|
||||
export module ftxui.component.captured_mouse;
|
||||
export module ftxui.component:CapturedMouse;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.component
|
||||
/// @module ftxui.component:Component
|
||||
/// @brief Module file for the Component classes of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/component.hpp>
|
||||
|
||||
export module ftxui.component.component;
|
||||
export module ftxui.component:Component;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
@@ -28,6 +28,10 @@ export namespace ftxui {
|
||||
using ftxui::operator|;
|
||||
using ftxui::operator|=;
|
||||
|
||||
/**
|
||||
* @namespace Container
|
||||
* @brief The FTXUI ftxui::Container:: namespace
|
||||
*/
|
||||
namespace Container {
|
||||
using ftxui::Container::Vertical;
|
||||
using ftxui::Container::Horizontal;
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.component_base
|
||||
/// @module ftxui.component:ComponentBase
|
||||
/// @brief Module file for the ComponentBase class of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/component_base.hpp>
|
||||
|
||||
export module ftxui.component.component_base;
|
||||
export module ftxui.component:ComponentBase;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
@@ -16,6 +16,10 @@ export namespace ftxui {
|
||||
using ftxui::Focus;
|
||||
using ftxui::Event;
|
||||
|
||||
/**
|
||||
* @namespace animation
|
||||
* @brief The FTXUI ftxui::animation:: namespace
|
||||
*/
|
||||
namespace animation {
|
||||
using ftxui::animation::Params;
|
||||
}
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.component_options
|
||||
/// @module ftxui.component:ComponentOptions
|
||||
/// @brief Module file for options for the Component class of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/component_options.hpp>
|
||||
|
||||
export module ftxui.component.component_options;
|
||||
export module ftxui.component:ComponentOptions;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.event
|
||||
/// @module ftxui.component:Event
|
||||
/// @brief Module file for the Event struct of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/event.hpp>
|
||||
|
||||
export module ftxui.component.event;
|
||||
export module ftxui.component:Event;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -173,7 +173,7 @@ class InputBase : public ComponentBase, public InputOption {
|
||||
elements.push_back(element);
|
||||
}
|
||||
|
||||
auto element = vbox(std::move(elements), cursor_line) | frame;
|
||||
auto element = vbox(std::move(elements)) | frame;
|
||||
return transform_func({
|
||||
std::move(element), hovered_, is_focused,
|
||||
false // placeholder
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.loop
|
||||
/// @module ftxui.component:Loop
|
||||
/// @brief Module file for the Loop class of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/loop.hpp>
|
||||
|
||||
export module ftxui.component.loop;
|
||||
export module ftxui.component:Loop;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -145,8 +145,8 @@ class MenuBase : public ComponentBase, public MenuOption {
|
||||
}
|
||||
|
||||
const Element bar = IsHorizontal()
|
||||
? hbox(std::move(elements), selected_focus_)
|
||||
: vbox(std::move(elements), selected_focus_);
|
||||
? hbox(std::move(elements))
|
||||
: vbox(std::move(elements));
|
||||
|
||||
if (!underline.enabled) {
|
||||
return bar | reflect(box_);
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.mouse
|
||||
/// @module ftxui.component:Mouse
|
||||
/// @brief Module file for the Mouse struct of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/mouse.hpp>
|
||||
|
||||
export module ftxui.component.mouse;
|
||||
export module ftxui.component:Mouse;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -46,7 +46,7 @@ class RadioboxBase : public ComponentBase, public RadioboxOption {
|
||||
}
|
||||
elements.push_back(element | reflect(boxes_[i]));
|
||||
}
|
||||
return vbox(std::move(elements), hovered_) | reflect(box_);
|
||||
return vbox(std::move(elements)) | reflect(box_);
|
||||
}
|
||||
|
||||
// NOLINTNEXTLINE(readability-function-cognitive-complexity)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.receiver
|
||||
/// @module ftxui.component:Receiver
|
||||
/// @brief Module file for the Receiver class of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/receiver.hpp>
|
||||
|
||||
export module ftxui.component.receiver;
|
||||
export module ftxui.component:Receiver;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
// Copyright 2021 Arthur Sonzogni. All rights reserved.
|
||||
// Use of this source code is governed by the MIT license that can be found in
|
||||
// the LICENSE file.
|
||||
#include <algorithm> // for max
|
||||
#include <ftxui/component/component_options.hpp> // for ResizableSplitOption
|
||||
#include <ftxui/dom/direction.hpp> // for Direction, Direction::Down, Direction::Left, Direction::Right, Direction::Up
|
||||
#include <ftxui/util/ref.hpp> // for Ref
|
||||
@@ -18,34 +19,22 @@
|
||||
namespace ftxui {
|
||||
namespace {
|
||||
|
||||
class ResizableSplitBase : public ComponentBase {
|
||||
class ResizableSplitBase : public ComponentBase, public ResizableSplitOption {
|
||||
public:
|
||||
explicit ResizableSplitBase(ResizableSplitOption options)
|
||||
: options_(std::move(options)) {
|
||||
switch (options_->direction()) {
|
||||
: ResizableSplitOption(std::move(options)) {
|
||||
switch (direction()) {
|
||||
case Direction::Left:
|
||||
Add(Container::Horizontal({
|
||||
options_->main,
|
||||
options_->back,
|
||||
}));
|
||||
Add(Container::Horizontal({main, back}));
|
||||
break;
|
||||
case Direction::Right:
|
||||
Add(Container::Horizontal({
|
||||
options_->back,
|
||||
options_->main,
|
||||
}));
|
||||
Add(Container::Horizontal({back, main}));
|
||||
break;
|
||||
case Direction::Up:
|
||||
Add(Container::Vertical({
|
||||
options_->main,
|
||||
options_->back,
|
||||
}));
|
||||
Add(Container::Vertical({main, back}));
|
||||
break;
|
||||
case Direction::Down:
|
||||
Add(Container::Vertical({
|
||||
options_->back,
|
||||
options_->main,
|
||||
}));
|
||||
Add(Container::Vertical({back, main}));
|
||||
break;
|
||||
}
|
||||
}
|
||||
@@ -75,27 +64,27 @@ class ResizableSplitBase : public ComponentBase {
|
||||
return ComponentBase::OnEvent(event);
|
||||
}
|
||||
|
||||
switch (options_->direction()) {
|
||||
switch (direction()) {
|
||||
case Direction::Left:
|
||||
options_->main_size() = std::max(0, event.mouse().x - box_.x_min);
|
||||
return true;
|
||||
main_size() = std::max(0, event.mouse().x - box_.x_min);
|
||||
break;
|
||||
case Direction::Right:
|
||||
options_->main_size() = std::max(0, box_.x_max - event.mouse().x);
|
||||
return true;
|
||||
main_size() = std::max(0, box_.x_max - event.mouse().x);
|
||||
break;
|
||||
case Direction::Up:
|
||||
options_->main_size() = std::max(0, event.mouse().y - box_.y_min);
|
||||
return true;
|
||||
main_size() = std::max(0, event.mouse().y - box_.y_min);
|
||||
break;
|
||||
case Direction::Down:
|
||||
options_->main_size() = std::max(0, box_.y_max - event.mouse().y);
|
||||
return true;
|
||||
main_size() = std::max(0, box_.y_max - event.mouse().y);
|
||||
break;
|
||||
}
|
||||
|
||||
// NOTREACHED()
|
||||
return false;
|
||||
main_size() = std::clamp(main_size(), min(), max());
|
||||
return true;
|
||||
}
|
||||
|
||||
Element OnRender() final {
|
||||
switch (options_->direction()) {
|
||||
switch (direction()) {
|
||||
case Direction::Left:
|
||||
return RenderLeft();
|
||||
case Direction::Right:
|
||||
@@ -111,46 +100,41 @@ class ResizableSplitBase : public ComponentBase {
|
||||
|
||||
Element RenderLeft() {
|
||||
return hbox({
|
||||
options_->main->Render() |
|
||||
size(WIDTH, EQUAL, options_->main_size()),
|
||||
options_->separator_func() | reflect(separator_box_),
|
||||
options_->back->Render() | xflex,
|
||||
main->Render() | size(WIDTH, EQUAL, main_size()),
|
||||
separator_func() | reflect(separator_box_),
|
||||
back->Render() | xflex,
|
||||
}) |
|
||||
reflect(box_);
|
||||
}
|
||||
|
||||
Element RenderRight() {
|
||||
return hbox({
|
||||
options_->back->Render() | xflex,
|
||||
options_->separator_func() | reflect(separator_box_),
|
||||
options_->main->Render() |
|
||||
size(WIDTH, EQUAL, options_->main_size()),
|
||||
back->Render() | xflex,
|
||||
separator_func() | reflect(separator_box_),
|
||||
main->Render() | size(WIDTH, EQUAL, main_size()),
|
||||
}) |
|
||||
reflect(box_);
|
||||
}
|
||||
|
||||
Element RenderTop() {
|
||||
return vbox({
|
||||
options_->main->Render() |
|
||||
size(HEIGHT, EQUAL, options_->main_size()),
|
||||
options_->separator_func() | reflect(separator_box_),
|
||||
options_->back->Render() | yflex,
|
||||
main->Render() | size(HEIGHT, EQUAL, main_size()),
|
||||
separator_func() | reflect(separator_box_),
|
||||
back->Render() | yflex,
|
||||
}) |
|
||||
reflect(box_);
|
||||
}
|
||||
|
||||
Element RenderBottom() {
|
||||
return vbox({
|
||||
options_->back->Render() | yflex,
|
||||
options_->separator_func() | reflect(separator_box_),
|
||||
options_->main->Render() |
|
||||
size(HEIGHT, EQUAL, options_->main_size()),
|
||||
back->Render() | yflex,
|
||||
separator_func() | reflect(separator_box_),
|
||||
main->Render() | size(HEIGHT, EQUAL, main_size()),
|
||||
}) |
|
||||
reflect(box_);
|
||||
}
|
||||
|
||||
private:
|
||||
Ref<ResizableSplitOption> options_;
|
||||
CapturedMouse captured_mouse_;
|
||||
Box separator_box_;
|
||||
Box box_;
|
||||
|
||||
@@ -233,5 +233,105 @@ TEST(ResizableSplit, NavigationVertical) {
|
||||
EXPECT_FALSE(component_bottom->Active());
|
||||
}
|
||||
|
||||
TEST(ResizableSplit, MinMaxSizeLeft) {
|
||||
int position = 5;
|
||||
auto component = ResizableSplit({
|
||||
.main = BasicComponent(),
|
||||
.back = BasicComponent(),
|
||||
.direction = Direction::Left,
|
||||
.main_size = &position,
|
||||
.separator_func = [] { return separatorDouble(); },
|
||||
.min = 3,
|
||||
.max = 8,
|
||||
});
|
||||
auto screen = Screen(20, 20);
|
||||
Render(screen, component->Render());
|
||||
EXPECT_EQ(position, 5);
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(5, 1)));
|
||||
EXPECT_EQ(position, 5);
|
||||
// Try to resize below min
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(2, 1)));
|
||||
EXPECT_EQ(position, 3); // Clamped to min
|
||||
// Try to resize above max
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(10, 1)));
|
||||
EXPECT_EQ(position, 8); // Clamped to max
|
||||
EXPECT_TRUE(component->OnEvent(MouseReleased(10, 1)));
|
||||
EXPECT_EQ(position, 8);
|
||||
}
|
||||
|
||||
TEST(ResizableSplit, MinMaxSizeRight) {
|
||||
int position = 5;
|
||||
auto component = ResizableSplit({
|
||||
.main = BasicComponent(),
|
||||
.back = BasicComponent(),
|
||||
.direction = Direction::Right,
|
||||
.main_size = &position,
|
||||
.separator_func = [] { return separatorDouble(); },
|
||||
.min = 3,
|
||||
.max = 8,
|
||||
});
|
||||
auto screen = Screen(20, 20);
|
||||
Render(screen, component->Render());
|
||||
EXPECT_EQ(position, 5);
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(14, 1)));
|
||||
EXPECT_EQ(position, 5);
|
||||
// Try to resize below min
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(18, 1)));
|
||||
EXPECT_EQ(position, 3); // Clamped to min
|
||||
// Try to resize above max
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(10, 1)));
|
||||
EXPECT_EQ(position, 8); // Clamped to max
|
||||
EXPECT_TRUE(component->OnEvent(MouseReleased(10, 1)));
|
||||
EXPECT_EQ(position, 8);
|
||||
}
|
||||
|
||||
TEST(ResizableSplit, MinMaxSizeTop) {
|
||||
int position = 5;
|
||||
auto component = ResizableSplit({
|
||||
.main = BasicComponent(),
|
||||
.back = BasicComponent(),
|
||||
.direction = Direction::Up,
|
||||
.main_size = &position,
|
||||
.separator_func = [] { return separatorDouble(); },
|
||||
.min = 2,
|
||||
.max = 10,
|
||||
});
|
||||
auto screen = Screen(20, 20);
|
||||
Render(screen, component->Render());
|
||||
EXPECT_EQ(position, 5);
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(1, 5)));
|
||||
EXPECT_EQ(position, 5);
|
||||
// Try to resize below min
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(1, 1)));
|
||||
EXPECT_EQ(position, 2); // Clamped to min
|
||||
// Try to resize above max
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(1, 15)));
|
||||
EXPECT_EQ(position, 10); // Clamped to max
|
||||
}
|
||||
|
||||
TEST(ResizableSplit, MinMaxSizeBottom) {
|
||||
int position = 5;
|
||||
auto component = ResizableSplit({
|
||||
.main = BasicComponent(),
|
||||
.back = BasicComponent(),
|
||||
.direction = Direction::Down,
|
||||
.main_size = &position,
|
||||
.separator_func = [] { return separatorDouble(); },
|
||||
.min = 3,
|
||||
.max = 12,
|
||||
});
|
||||
auto screen = Screen(20, 20);
|
||||
Render(screen, component->Render());
|
||||
EXPECT_EQ(position, 5);
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(1, 14)));
|
||||
EXPECT_EQ(position, 5);
|
||||
// Try to resize below min
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(1, 18)));
|
||||
EXPECT_EQ(position, 3); // Clamped to min
|
||||
// Try to resize above max
|
||||
EXPECT_TRUE(component->OnEvent(MousePressed(1, 5)));
|
||||
EXPECT_EQ(position, 12); // Clamped to max
|
||||
}
|
||||
|
||||
} // namespace ftxui
|
||||
// NOLINTEND
|
||||
|
||||
@@ -112,13 +112,13 @@ void ftxui_on_resize(int columns, int rows) {
|
||||
|
||||
#else // POSIX (Linux & Mac)
|
||||
|
||||
int CheckStdinReady() {
|
||||
int CheckStdinReady(int fd) {
|
||||
timeval tv = {0, 0}; // NOLINT
|
||||
fd_set fds;
|
||||
FD_ZERO(&fds); // NOLINT
|
||||
FD_SET(STDIN_FILENO, &fds); // NOLINT
|
||||
select(STDIN_FILENO + 1, &fds, nullptr, nullptr, &tv); // NOLINT
|
||||
return FD_ISSET(STDIN_FILENO, &fds); // NOLINT
|
||||
FD_SET(fd, &fds); // NOLINT
|
||||
select(fd + 1, &fds, nullptr, nullptr, &tv); // NOLINT
|
||||
return FD_ISSET(fd, &fds); // NOLINT
|
||||
}
|
||||
|
||||
#endif
|
||||
@@ -372,6 +372,18 @@ void ScreenInteractive::TrackMouse(bool enable) {
|
||||
track_mouse_ = enable;
|
||||
}
|
||||
|
||||
/// @brief Enable or disable automatic piped input handling.
|
||||
/// When enabled, FTXUI will detect piped input and redirect stdin from /dev/tty
|
||||
/// for keyboard input, allowing applications to read piped data while still
|
||||
/// receiving interactive keyboard events.
|
||||
/// @param enable Whether to enable piped input handling. Default is true.
|
||||
/// @note This must be called before Loop().
|
||||
/// @note This feature is enabled by default.
|
||||
/// @note This feature is only available on POSIX systems (Linux/macOS).
|
||||
void ScreenInteractive::HandlePipedInput(bool enable) {
|
||||
handle_piped_input_ = enable;
|
||||
}
|
||||
|
||||
/// @brief Add a task to the main loop.
|
||||
/// It will be executed later, after every other scheduled tasks.
|
||||
void ScreenInteractive::Post(Task task) {
|
||||
@@ -527,6 +539,8 @@ void ScreenInteractive::Install() {
|
||||
// https://github.com/ArthurSonzogni/FTXUI/issues/846
|
||||
Flush();
|
||||
|
||||
InstallPipedInputHandling();
|
||||
|
||||
// After uninstalling the new configuration, flush it to the terminal to
|
||||
// ensure it is fully applied:
|
||||
on_exit_functions.emplace([] { Flush(); });
|
||||
@@ -592,9 +606,10 @@ void ScreenInteractive::Install() {
|
||||
}
|
||||
|
||||
struct termios terminal; // NOLINT
|
||||
tcgetattr(STDIN_FILENO, &terminal);
|
||||
on_exit_functions.emplace(
|
||||
[=] { tcsetattr(STDIN_FILENO, TCSANOW, &terminal); });
|
||||
tcgetattr(tty_fd_, &terminal);
|
||||
on_exit_functions.emplace([terminal = terminal, tty_fd_ = tty_fd_] {
|
||||
tcsetattr(tty_fd_, TCSANOW, &terminal);
|
||||
});
|
||||
|
||||
// Enabling raw terminal input mode
|
||||
terminal.c_iflag &= ~IGNBRK; // Disable ignoring break condition
|
||||
@@ -622,7 +637,7 @@ void ScreenInteractive::Install() {
|
||||
// read.
|
||||
terminal.c_cc[VTIME] = 0; // Timeout in deciseconds for non-canonical read.
|
||||
|
||||
tcsetattr(STDIN_FILENO, TCSANOW, &terminal);
|
||||
tcsetattr(tty_fd_, TCSANOW, &terminal);
|
||||
|
||||
#endif
|
||||
|
||||
@@ -663,6 +678,37 @@ void ScreenInteractive::Install() {
|
||||
PostAnimationTask();
|
||||
}
|
||||
|
||||
void ScreenInteractive::InstallPipedInputHandling() {
|
||||
#if !defined(_WIN32) && !defined(__EMSCRIPTEN__)
|
||||
tty_fd_ = STDIN_FILENO;
|
||||
// Handle piped input redirection if explicitly enabled by the application.
|
||||
// This allows applications to read data from stdin while still receiving
|
||||
// keyboard input from the terminal for interactive use.
|
||||
if (!handle_piped_input_) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If stdin is a terminal, we don't need to open /dev/tty.
|
||||
if (isatty(STDIN_FILENO)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Open /dev/tty for keyboard input.
|
||||
tty_fd_ = open("/dev/tty", O_RDONLY);
|
||||
if (tty_fd_ < 0) {
|
||||
// Failed to open /dev/tty (containers, headless systems, etc.)
|
||||
tty_fd_ = STDIN_FILENO; // Fallback to stdin.
|
||||
return;
|
||||
}
|
||||
|
||||
// Close the /dev/tty file descriptor on exit.
|
||||
on_exit_functions.emplace([this] {
|
||||
close(tty_fd_);
|
||||
tty_fd_ = -1;
|
||||
});
|
||||
#endif
|
||||
}
|
||||
|
||||
// private
|
||||
void ScreenInteractive::Uninstall() {
|
||||
ExitNow();
|
||||
@@ -1096,7 +1142,7 @@ void ScreenInteractive::FetchTerminalEvents() {
|
||||
internal_->terminal_input_parser.Add(out[i]);
|
||||
}
|
||||
#else // POSIX (Linux & Mac)
|
||||
if (!CheckStdinReady()) {
|
||||
if (!CheckStdinReady(tty_fd_)) {
|
||||
const auto timeout =
|
||||
std::chrono::steady_clock::now() - internal_->last_char_time;
|
||||
const size_t timeout_ms =
|
||||
@@ -1108,7 +1154,7 @@ void ScreenInteractive::FetchTerminalEvents() {
|
||||
|
||||
// Read chars from the terminal.
|
||||
std::array<char, 128> out{};
|
||||
size_t l = read(fileno(stdin), out.data(), out.size());
|
||||
size_t l = read(tty_fd_, out.data(), out.size());
|
||||
|
||||
// Convert the chars to events.
|
||||
for (size_t i = 0; i < l; ++i) {
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.screen_interactive
|
||||
/// @module ftxui.component:ScreenInteractive
|
||||
/// @brief Module file for the ScreenInteractive class of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/screen_interactive.hpp>
|
||||
|
||||
export module ftxui.component.screen_interactive;
|
||||
export module ftxui.component:ScreenInteractive;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
222
src/ftxui/component/screen_interactive_piped_input_test.cpp
Normal file
222
src/ftxui/component/screen_interactive_piped_input_test.cpp
Normal file
@@ -0,0 +1,222 @@
|
||||
// Copyright 2025 Arthur Sonzogni. All rights reserved.
|
||||
// Use of this source code is governed by the MIT license that can be found in
|
||||
// the LICENSE file.
|
||||
#include <fcntl.h>
|
||||
#include <gtest/gtest.h>
|
||||
#include <sys/stat.h>
|
||||
#include <unistd.h>
|
||||
#include <cstdio>
|
||||
|
||||
#include "ftxui/component/component.hpp"
|
||||
#include "ftxui/component/screen_interactive.hpp"
|
||||
#include "ftxui/dom/elements.hpp"
|
||||
|
||||
#if !defined(_WIN32) && !defined(__EMSCRIPTEN__)
|
||||
|
||||
namespace ftxui {
|
||||
|
||||
namespace {
|
||||
|
||||
// Test fixture for piped input functionality
|
||||
class PipedInputTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
// Save original stdin for restoration
|
||||
original_stdin_ = dup(STDIN_FILENO);
|
||||
}
|
||||
|
||||
void TearDown() override {
|
||||
// Restore original stdin
|
||||
if (original_stdin_ >= 0) {
|
||||
dup2(original_stdin_, STDIN_FILENO);
|
||||
close(original_stdin_);
|
||||
}
|
||||
}
|
||||
|
||||
// Create a pipe and redirect stdin to read from it
|
||||
void SetupPipedStdin() {
|
||||
if (pipe(pipe_fds_) == 0) {
|
||||
dup2(pipe_fds_[0], STDIN_FILENO);
|
||||
close(pipe_fds_[0]);
|
||||
// Keep write end open for writing test data
|
||||
piped_stdin_setup_ = true;
|
||||
}
|
||||
}
|
||||
|
||||
// Write test data to the piped stdin
|
||||
void WriteToPipedStdin(const std::string& data) {
|
||||
if (piped_stdin_setup_) {
|
||||
write(pipe_fds_[1], data.c_str(), data.length());
|
||||
close(pipe_fds_[1]); // Close write end to signal EOF
|
||||
}
|
||||
}
|
||||
|
||||
// Check if /dev/tty is available (not available in some CI environments)
|
||||
bool IsTtyAvailable() {
|
||||
struct stat st;
|
||||
return stat("/dev/tty", &st) == 0;
|
||||
}
|
||||
|
||||
private:
|
||||
int original_stdin_ = -1;
|
||||
int pipe_fds_[2] = {-1, -1};
|
||||
bool piped_stdin_setup_ = false;
|
||||
};
|
||||
|
||||
TEST_F(PipedInputTest, DefaultBehaviorEnabled) {
|
||||
// Test that HandlePipedInput is enabled by default
|
||||
if (!IsTtyAvailable()) {
|
||||
GTEST_SKIP() << "/dev/tty not available in this environment";
|
||||
}
|
||||
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
auto component = Renderer([] { return text("test"); });
|
||||
|
||||
SetupPipedStdin();
|
||||
WriteToPipedStdin("test data\n");
|
||||
|
||||
// Install should redirect stdin since HandlePipedInput is on by default
|
||||
screen.Install();
|
||||
|
||||
// Stdin should be the tty
|
||||
EXPECT_TRUE(isatty(STDIN_FILENO));
|
||||
|
||||
screen.Uninstall();
|
||||
}
|
||||
|
||||
TEST_F(PipedInputTest, ExplicitlyDisabled) {
|
||||
// Test that explicitly disabling works
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
screen.HandlePipedInput(false);
|
||||
auto component = Renderer([] { return text("test"); });
|
||||
|
||||
SetupPipedStdin();
|
||||
WriteToPipedStdin("test data\n");
|
||||
|
||||
screen.Install();
|
||||
|
||||
// Stdin should still be the pipe since feature is disabled
|
||||
EXPECT_FALSE(isatty(STDIN_FILENO));
|
||||
|
||||
screen.Uninstall();
|
||||
}
|
||||
|
||||
TEST_F(PipedInputTest, ExplicitlyEnabled) {
|
||||
if (!IsTtyAvailable()) {
|
||||
GTEST_SKIP() << "/dev/tty not available in this environment";
|
||||
}
|
||||
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
screen.HandlePipedInput(true); // Explicitly enable
|
||||
auto component = Renderer([] { return text("test"); });
|
||||
|
||||
SetupPipedStdin();
|
||||
WriteToPipedStdin("test data\n");
|
||||
|
||||
// Before install: stdin should be piped
|
||||
EXPECT_FALSE(isatty(STDIN_FILENO));
|
||||
|
||||
screen.Install();
|
||||
|
||||
// After install with piped input handling: stdin should be redirected to tty
|
||||
EXPECT_TRUE(isatty(STDIN_FILENO));
|
||||
|
||||
screen.Uninstall();
|
||||
|
||||
// After uninstall: stdin should be restored to original state
|
||||
// Note: This will be the pipe we set up, so it should be non-tty
|
||||
EXPECT_FALSE(isatty(STDIN_FILENO));
|
||||
}
|
||||
|
||||
TEST_F(PipedInputTest, NormalStdinUnchanged) {
|
||||
// Test that normal stdin (not piped) is not affected
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
auto component = Renderer([] { return text("test"); });
|
||||
|
||||
// Don't setup piped stdin - use normal stdin
|
||||
bool original_isatty = isatty(STDIN_FILENO);
|
||||
|
||||
screen.Install();
|
||||
|
||||
// Stdin should remain unchanged
|
||||
EXPECT_EQ(original_isatty, isatty(STDIN_FILENO));
|
||||
|
||||
screen.Uninstall();
|
||||
|
||||
// Stdin should still be unchanged
|
||||
EXPECT_EQ(original_isatty, isatty(STDIN_FILENO));
|
||||
}
|
||||
|
||||
TEST_F(PipedInputTest, MultipleInstallUninstallCycles) {
|
||||
if (!IsTtyAvailable()) {
|
||||
GTEST_SKIP() << "/dev/tty not available in this environment";
|
||||
}
|
||||
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
auto component = Renderer([] { return text("test"); });
|
||||
|
||||
SetupPipedStdin();
|
||||
WriteToPipedStdin("test data\n");
|
||||
|
||||
// First cycle
|
||||
screen.Install();
|
||||
EXPECT_TRUE(isatty(STDIN_FILENO));
|
||||
screen.Uninstall();
|
||||
EXPECT_FALSE(isatty(STDIN_FILENO));
|
||||
|
||||
// Second cycle should work the same
|
||||
screen.Install();
|
||||
EXPECT_TRUE(isatty(STDIN_FILENO));
|
||||
screen.Uninstall();
|
||||
EXPECT_FALSE(isatty(STDIN_FILENO));
|
||||
}
|
||||
|
||||
TEST_F(PipedInputTest, HandlePipedInputMethodBehavior) {
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
|
||||
// Test method can be called multiple times
|
||||
screen.HandlePipedInput(true);
|
||||
screen.HandlePipedInput(false);
|
||||
screen.HandlePipedInput(true);
|
||||
|
||||
// Should be enabled after last call
|
||||
SetupPipedStdin();
|
||||
WriteToPipedStdin("test data\n");
|
||||
|
||||
if (IsTtyAvailable()) {
|
||||
screen.Install();
|
||||
EXPECT_TRUE(isatty(STDIN_FILENO));
|
||||
screen.Uninstall();
|
||||
}
|
||||
}
|
||||
|
||||
// Test the graceful fallback when /dev/tty is not available
|
||||
// This test simulates environments like containers where /dev/tty might not
|
||||
// exist
|
||||
TEST_F(PipedInputTest, GracefulFallbackWhenTtyUnavailable) {
|
||||
auto screen = ScreenInteractive::TerminalOutput();
|
||||
auto component = Renderer([] { return text("test"); });
|
||||
|
||||
SetupPipedStdin();
|
||||
WriteToPipedStdin("test data\n");
|
||||
|
||||
// This test doesn't directly mock /dev/tty unavailability since that's hard
|
||||
// to do in a unit test environment, but the code path handles freopen()
|
||||
// failure gracefully
|
||||
screen.Install();
|
||||
|
||||
// The behavior depends on whether /dev/tty is available
|
||||
// If available, stdin gets redirected; if not, it remains piped
|
||||
// Both behaviors are correct
|
||||
|
||||
screen.Uninstall();
|
||||
|
||||
// After uninstall, stdin should be restored
|
||||
EXPECT_FALSE(isatty(STDIN_FILENO)); // Should still be our test pipe
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
} // namespace ftxui
|
||||
|
||||
#endif // !defined(_WIN32) && !defined(__EMSCRIPTEN__)
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.component.task
|
||||
/// @module ftxui.component:Task
|
||||
/// @brief Module file for the Task class of the Component module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/component/task.hpp>
|
||||
|
||||
export module ftxui.component.task;
|
||||
export module ftxui.component:Task;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -21,8 +21,8 @@ class TaskRunner {
|
||||
auto PostTask(Task task) -> void;
|
||||
|
||||
/// Schedules a task to be executed after a certain duration.
|
||||
auto PostDelayedTask(Task task, std::chrono::steady_clock::duration duration)
|
||||
-> void;
|
||||
auto PostDelayedTask(Task task,
|
||||
std::chrono::steady_clock::duration duration) -> void;
|
||||
|
||||
/// Runs the tasks in the queue, return the delay until the next delayed task
|
||||
/// can be executed.
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
/// @module ftxui.dom
|
||||
/// @brief Module file for FTXUI main operations.
|
||||
/// @brief Module file for FTXUI DOM operations.
|
||||
|
||||
export module ftxui.dom;
|
||||
|
||||
export import ftxui.dom.canvas;
|
||||
export import ftxui.dom.deprecated;
|
||||
export import ftxui.dom.direction;
|
||||
export import ftxui.dom.elements;
|
||||
export import ftxui.dom.flexbox_config;
|
||||
export import ftxui.dom.linear_gradient;
|
||||
export import ftxui.dom.node;
|
||||
export import ftxui.dom.requirement;
|
||||
export import ftxui.dom.selection;
|
||||
export import ftxui.dom.table;
|
||||
export import :Canvas;
|
||||
export import :Deprecated;
|
||||
export import :Direction;
|
||||
export import :Elements;
|
||||
export import :FlexboxConfig;
|
||||
export import :LinearGradient;
|
||||
export import :Node;
|
||||
export import :Requirement;
|
||||
export import :Selection;
|
||||
export import :Table;
|
||||
|
||||
@@ -4,11 +4,18 @@
|
||||
#include "ftxui/dom/box_helper.hpp"
|
||||
|
||||
#include <algorithm> // for max
|
||||
#include <cstdint>
|
||||
#include <vector> // for vector
|
||||
|
||||
namespace ftxui::box_helper {
|
||||
|
||||
namespace {
|
||||
|
||||
int SafeRatio(int value, int numerator, int denominator) {
|
||||
return static_cast<int64_t>(value) * static_cast<int64_t>(numerator) /
|
||||
std::max(static_cast<int64_t>(denominator), static_cast<int64_t>(1));
|
||||
}
|
||||
|
||||
// Called when the size allowed is greater than the requested size. This
|
||||
// distributes the extra spaces toward the flexible elements, in relative
|
||||
// proportions.
|
||||
@@ -17,7 +24,7 @@ void ComputeGrow(std::vector<Element>* elements,
|
||||
int flex_grow_sum) {
|
||||
for (Element& element : *elements) {
|
||||
const int added_space =
|
||||
extra_space * element.flex_grow / std::max(flex_grow_sum, 1);
|
||||
SafeRatio(extra_space, element.flex_grow, flex_grow_sum);
|
||||
extra_space -= added_space;
|
||||
flex_grow_sum -= element.flex_grow;
|
||||
element.size = element.min_size + added_space;
|
||||
@@ -31,8 +38,8 @@ void ComputeShrinkEasy(std::vector<Element>* elements,
|
||||
int extra_space,
|
||||
int flex_shrink_sum) {
|
||||
for (Element& element : *elements) {
|
||||
const int added_space = extra_space * element.min_size *
|
||||
element.flex_shrink / std::max(flex_shrink_sum, 1);
|
||||
const int added_space = SafeRatio(
|
||||
extra_space, element.min_size * element.flex_shrink, flex_shrink_sum);
|
||||
extra_space -= added_space;
|
||||
flex_shrink_sum -= element.flex_shrink * element.min_size;
|
||||
element.size = element.min_size + added_space;
|
||||
@@ -40,7 +47,7 @@ void ComputeShrinkEasy(std::vector<Element>* elements,
|
||||
}
|
||||
|
||||
// Called when the size allowed is lower than the requested size, and the
|
||||
// shrinkable element can not absorbe the (negative) extra_space. This assign
|
||||
// shrinkable element can not absorb the (negative) extra_space. This assigns
|
||||
// zero to shrinkable elements and distribute the remaining (negative)
|
||||
// extra_space toward the other non shrinkable elements.
|
||||
void ComputeShrinkHard(std::vector<Element>* elements,
|
||||
@@ -52,7 +59,8 @@ void ComputeShrinkHard(std::vector<Element>* elements,
|
||||
continue;
|
||||
}
|
||||
|
||||
const int added_space = extra_space * element.min_size / std::max(1, size);
|
||||
const int added_space = SafeRatio(extra_space, element.min_size, size);
|
||||
|
||||
extra_space -= added_space;
|
||||
size -= element.min_size;
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.canvas
|
||||
/// @brief Module file for the Canvas struct of the Dom module
|
||||
/// @module ftxui.dom:Canvas
|
||||
/// @brief Module file for the Canvas struct of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/canvas.hpp>
|
||||
|
||||
export module ftxui.dom.canvas;
|
||||
export module ftxui.dom:Canvas;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.deprecated
|
||||
/// @brief Module file for deprecated parts of the Dom module
|
||||
/// @module ftxui.dom:Deprecated
|
||||
/// @brief Module file for deprecated parts of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/deprecated.hpp>
|
||||
|
||||
export module ftxui.dom.deprecated;
|
||||
export module ftxui.dom:Deprecated;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.direction
|
||||
/// @module ftxui.dom:Direction
|
||||
/// @brief Module file for the Direction enum of the Dom module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/direction.hpp>
|
||||
|
||||
export module ftxui.dom.direction;
|
||||
export module ftxui.dom:Direction;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.elements
|
||||
/// @brief Module file for the Element classes and functions of the Dom module
|
||||
/// @module ftxui.dom:Elements
|
||||
/// @brief Module file for the Element classes and functions of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/elements.hpp>
|
||||
|
||||
export module ftxui.dom.elements;
|
||||
export module ftxui.dom:Elements;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.flexbox_config
|
||||
/// @brief Module file for the FlexboxConfig struct of the Dom module
|
||||
/// @module ftxui.dom:FlexboxConfig
|
||||
/// @brief Module file for the FlexboxConfig struct of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/flexbox_config.hpp>
|
||||
|
||||
export module ftxui.dom.flexbox_config;
|
||||
export module ftxui.dom:FlexboxConfig;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -2,8 +2,12 @@
|
||||
// Use of this source code is governed by the MIT license that can be found in
|
||||
// the LICENSE file.
|
||||
#include <gtest/gtest.h> // for Test, TestInfo (ptr only), EXPECT_EQ, Message, TEST, TestPartResult
|
||||
#include <array> // for array
|
||||
#include <cstddef> // for size_t
|
||||
#include <queue>
|
||||
#include <stack> // for stack
|
||||
#include <string> // for allocator, basic_string, string
|
||||
#include <unordered_set> // for unordered_set
|
||||
#include <vector> // for vector
|
||||
|
||||
#include "ftxui/dom/elements.hpp" // for text, operator|, Element, flex_grow, flex_shrink, hbox
|
||||
@@ -358,5 +362,39 @@ TEST(HBoxTest, FlexGrow_NoFlex_FlewShrink) {
|
||||
}
|
||||
}
|
||||
|
||||
TEST(HBoxTest, FromElementsContainer) {
|
||||
Elements elements_vector{text("0"), text("1")};
|
||||
|
||||
std::array<Element, 2> elements_array{text("0"), text("1")};
|
||||
|
||||
std::deque<Element> elements_deque{text("0"), text("1")};
|
||||
|
||||
std::stack<Element> elements_stack;
|
||||
elements_stack.push(text("1"));
|
||||
elements_stack.push(text("0"));
|
||||
|
||||
std::queue<Element> elements_queue;
|
||||
elements_queue.emplace(text("0"));
|
||||
elements_queue.emplace(text("1"));
|
||||
|
||||
const std::vector<Element> collection_hboxes{
|
||||
hbox(std::move(elements_vector)), hbox(std::move(elements_array)),
|
||||
hbox(std::move(elements_stack)), hbox(std::move(elements_deque)),
|
||||
hbox(std::move(elements_queue)),
|
||||
};
|
||||
|
||||
for (const Element& collection_hbox : collection_hboxes) {
|
||||
Screen screen(2, 1);
|
||||
Render(screen, collection_hbox);
|
||||
EXPECT_EQ("01", screen.ToString());
|
||||
}
|
||||
|
||||
// Exception: unordered set, which has no guaranteed order.
|
||||
std::unordered_set<Element> elements_set{text("0"), text("0")};
|
||||
Screen screen(2, 1);
|
||||
Render(screen, hbox(elements_set));
|
||||
EXPECT_EQ("00", screen.ToString());
|
||||
};
|
||||
|
||||
} // namespace ftxui
|
||||
// NOLINTEND
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.linear_gradient
|
||||
/// @brief Module file for the LinearGradient struct of the Dom module
|
||||
/// @module ftxui.dom:LinearGradient
|
||||
/// @brief Module file for the LinearGradient struct of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/linear_gradient.hpp>
|
||||
|
||||
export module ftxui.dom.linear_gradient;
|
||||
export module ftxui.dom:LinearGradient;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.node
|
||||
/// @brief Module file for the Node class of the Dom module
|
||||
/// @module ftxui.dom:Node
|
||||
/// @brief Module file for the Node class of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/node.hpp>
|
||||
|
||||
export module ftxui.dom.node;
|
||||
export module ftxui.dom:Node;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.requirement
|
||||
/// @brief Module file for the Requirement struct of the Dom module
|
||||
/// @module ftxui.dom:Requirement
|
||||
/// @brief Module file for the Requirement struct of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/requirement.hpp>
|
||||
|
||||
export module ftxui.dom.requirement;
|
||||
export module ftxui.dom:Requirement;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.selection
|
||||
/// @brief Module file for the Selection class of the Dom module
|
||||
/// @module ftxui.dom:Selection
|
||||
/// @brief Module file for the Selection class of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/selection.hpp>
|
||||
|
||||
export module ftxui.dom.selection;
|
||||
export module ftxui.dom:Selection;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -81,7 +81,7 @@ class Size : public Node {
|
||||
} // namespace
|
||||
|
||||
/// @brief Apply a constraint on the size of an element.
|
||||
/// @param direction Whether the WIDTH of the HEIGHT of the element must be
|
||||
/// @param direction Whether the WIDTH or the HEIGHT of the element must be
|
||||
/// constrained.
|
||||
/// @param constraint The type of constaint.
|
||||
/// @param value The value.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.dom.table
|
||||
/// @brief Module file for the Table class of the Dom module
|
||||
/// @module ftxui.dom:Table
|
||||
/// @brief Module file for the Table class of the DOM module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/dom/table.hpp>
|
||||
|
||||
export module ftxui.dom.table;
|
||||
export module ftxui.dom:Table;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
export module ftxui.screen;
|
||||
|
||||
export import ftxui.screen.box;
|
||||
export import ftxui.screen.color;
|
||||
export import ftxui.screen.color_info;
|
||||
export import ftxui.screen.deprecated;
|
||||
export import ftxui.screen.image;
|
||||
export import ftxui.screen.pixel;
|
||||
export import ftxui.screen.screen;
|
||||
export import ftxui.screen.string;
|
||||
export import ftxui.screen.terminal;
|
||||
export import :Box;
|
||||
export import :Color;
|
||||
export import :ColorInfo;
|
||||
export import :Deprecated;
|
||||
export import :Image;
|
||||
export import :Pixel;
|
||||
export import :Screen;
|
||||
export import :String;
|
||||
export import :Terminal;
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.box
|
||||
/// @module ftxui.screen:Box
|
||||
/// @brief Module file for the Box struct of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/box.hpp>
|
||||
|
||||
export module ftxui.screen.box;
|
||||
export module ftxui.screen:Box;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.color
|
||||
/// @module ftxui.screen:Color
|
||||
/// @brief Module file for the Color class of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/color.hpp>
|
||||
|
||||
export module ftxui.screen.color;
|
||||
export module ftxui.screen:Color;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
@@ -14,6 +14,10 @@ export module ftxui.screen.color;
|
||||
export namespace ftxui {
|
||||
using ftxui::Color;
|
||||
|
||||
/**
|
||||
* @namespace literals
|
||||
* @brief The FTXUI ftxui::literals:: namespace
|
||||
*/
|
||||
inline namespace literals {
|
||||
using ftxui::literals::operator""_rgb;
|
||||
}
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.color_info
|
||||
/// @module ftxui.screen:ColorInfo
|
||||
/// @brief Module file for the ColorInfo struct of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/color_info.hpp>
|
||||
|
||||
export module ftxui.screen.color_info;
|
||||
export module ftxui.screen:ColorInfo;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.deprecated
|
||||
/// @module ftxui.screen:Deprecated
|
||||
/// @brief Module file for the deprecated parts of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/deprecated.hpp>
|
||||
|
||||
export module ftxui.screen.deprecated;
|
||||
export module ftxui.screen:Deprecated;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.image
|
||||
/// @module ftxui.screen:Image
|
||||
/// @brief Module file for the Image class of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/image.hpp>
|
||||
|
||||
export module ftxui.screen.image;
|
||||
export module ftxui.screen:Image;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.pixel
|
||||
/// @module ftxui.screen:Pixel
|
||||
/// @brief Module file for the Pixel struct of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/pixel.hpp>
|
||||
|
||||
export module ftxui.screen.pixel;
|
||||
export module ftxui.screen:Pixel;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,17 +1,21 @@
|
||||
/// @module ftxui.screen.screen
|
||||
/// @module ftxui.screen:Screen
|
||||
/// @brief Module file for the Screen class of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/screen.hpp>
|
||||
|
||||
export module ftxui.screen.screen;
|
||||
export module ftxui.screen:Screen;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
* @brief The FTXUI ftxui:: namespace
|
||||
*/
|
||||
export namespace ftxui {
|
||||
/**
|
||||
* @namespace Dimension
|
||||
* @brief The FTXUI ftxui::Dimension:: namespace
|
||||
*/
|
||||
namespace Dimension {
|
||||
using ftxui::Dimension::Fixed;
|
||||
using ftxui::Dimension::Full;
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.string
|
||||
/// @module ftxui.screen:String
|
||||
/// @brief Module file for string functions of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/string.hpp>
|
||||
|
||||
export module ftxui.screen.string;
|
||||
export module ftxui.screen:String;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.screen.terminal
|
||||
/// @module ftxui.screen:Terminal
|
||||
/// @brief Module file for the Terminal namespace of the Screen module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/screen/terminal.hpp>
|
||||
|
||||
export module ftxui.screen.terminal;
|
||||
export module ftxui.screen:Terminal;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
@@ -14,6 +14,10 @@ export module ftxui.screen.terminal;
|
||||
export namespace ftxui {
|
||||
using ftxui::Dimensions;
|
||||
|
||||
/**
|
||||
* @namespace Terminal
|
||||
* @brief The FTXUI ftxui::Terminal:: namespace
|
||||
*/
|
||||
namespace Terminal {
|
||||
using ftxui::Terminal::Size;
|
||||
using ftxui::Terminal::SetFallbackSize;
|
||||
|
||||
@@ -3,5 +3,5 @@
|
||||
|
||||
export module ftxui.util;
|
||||
|
||||
export import ftxui.util.autoreset;
|
||||
export import ftxui.util.ref;
|
||||
export import :AutoReset;
|
||||
export import :Ref;
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.util.autoreset
|
||||
/// @module ftxui.util:AutoReset
|
||||
/// @brief Module file for the AutoReset class of the Util module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/util/autoreset.hpp>
|
||||
|
||||
export module ftxui.util.autoreset;
|
||||
export module ftxui.util:AutoReset;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
/// @module ftxui.util.ref
|
||||
/// @module ftxui.util:Ref
|
||||
/// @brief Module file for the Ref classes of the Util module
|
||||
|
||||
module;
|
||||
|
||||
#include <ftxui/util/ref.hpp>
|
||||
|
||||
export module ftxui.util.ref;
|
||||
export module ftxui.util:Ref;
|
||||
|
||||
/**
|
||||
* @namespace ftxui
|
||||
|
||||
230
tools/build_multiversion_doc.py
Executable file
230
tools/build_multiversion_doc.py
Executable file
@@ -0,0 +1,230 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import shutil
|
||||
import tempfile
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import List, Dict
|
||||
|
||||
class VersionInfo:
|
||||
"""A structure to hold all information about a single documentation version."""
|
||||
def __init__(self, name: str, is_main: bool, output_root: Path):
|
||||
self.name = name
|
||||
self.is_main = is_main
|
||||
# Destination directory for the built docs, relative to the output root.
|
||||
self.dest_dir = output_root if is_main else output_root / "en" / name
|
||||
# The path to this version's index.html, relative to the output root.
|
||||
self.index_path_from_root = self.dest_dir / "index.html"
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"VersionInfo(name='{self.name}', dest_dir='{self.dest_dir}')"
|
||||
|
||||
def run_command(command: List[str], check: bool = True, cwd: Path = None):
|
||||
"""
|
||||
Runs a command, prints its output, and handles errors.
|
||||
"""
|
||||
command_str = ' '.join(command)
|
||||
print(f"Executing: {command_str} in {cwd or Path.cwd()}")
|
||||
try:
|
||||
# Using capture_output=True to get stdout/stderr
|
||||
result = subprocess.run(
|
||||
command,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
check=check,
|
||||
cwd=cwd
|
||||
)
|
||||
if result.stdout:
|
||||
print(result.stdout)
|
||||
if result.stderr:
|
||||
print(result.stderr)
|
||||
return result
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f"ERROR: Command failed with exit code {e.returncode}")
|
||||
print(f"Command: {command_str}")
|
||||
if e.stdout:
|
||||
print("--- STDOUT ---")
|
||||
print(e.stdout)
|
||||
if e.stderr:
|
||||
print("--- STDERR ---")
|
||||
print(e.stderr)
|
||||
raise # Re-raise the exception to halt the script
|
||||
|
||||
def get_version_switcher_js(
|
||||
current_version: VersionInfo,
|
||||
all_versions: List[VersionInfo],
|
||||
current_html_file: Path
|
||||
) -> str:
|
||||
"""
|
||||
Generates the JavaScript for the version switcher dropdown.
|
||||
|
||||
This version pre-calculates the relative path from the current HTML file
|
||||
to the index.html of every other version, simplifying the JS logic.
|
||||
"""
|
||||
version_names = [v.name for v in all_versions]
|
||||
|
||||
# Create a dictionary mapping version names to their relative URLs.
|
||||
relative_paths: Dict[str, str] = {}
|
||||
for version in all_versions:
|
||||
# Calculate the relative path from the *parent directory* of the current HTML file
|
||||
# to the target version's index.html.
|
||||
path = os.path.relpath(version.index_path_from_root, current_html_file.parent)
|
||||
relative_paths[version.name] = path
|
||||
|
||||
# Use json.dumps for safe serialization of data into JavaScript.
|
||||
versions_json = json.dumps(version_names)
|
||||
paths_json = json.dumps(relative_paths)
|
||||
current_version_json = json.dumps(current_version.name)
|
||||
|
||||
return f"""
|
||||
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 = {versions_json};
|
||||
const version_paths = {paths_json};
|
||||
const currentVersion = {current_version_json};
|
||||
|
||||
// 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'
|
||||
}});
|
||||
}});
|
||||
"""
|
||||
|
||||
def main():
|
||||
"""Main function to build multi-version documentation."""
|
||||
root_dir = Path.cwd()
|
||||
output_dir = root_dir / "multiversion_docs"
|
||||
|
||||
print("--- 1. Cleaning up old documentation ---")
|
||||
if output_dir.exists():
|
||||
shutil.rmtree(output_dir)
|
||||
output_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
print("--- 2. Getting versions from git ---")
|
||||
git_tags_result = run_command(["git", "tag", "--list", "v*"])
|
||||
# Create a list of version names, starting with 'main'.
|
||||
version_names = ["main"] + sorted(
|
||||
git_tags_result.stdout.splitlines(),
|
||||
reverse=True
|
||||
)
|
||||
print(f"Versions to build: {', '.join(version_names)}")
|
||||
|
||||
# Pre-compute all version information and paths.
|
||||
versions = [
|
||||
VersionInfo(name, name == "main", output_dir)
|
||||
for name in version_names
|
||||
]
|
||||
|
||||
with tempfile.TemporaryDirectory() as build_dir_str:
|
||||
build_dir = Path(build_dir_str)
|
||||
# --- 3. Build documentation for each version ---
|
||||
for version in versions:
|
||||
print(f"\n--- Building docs for version: {version.name} ---")
|
||||
|
||||
# Create a temporary directory for this version's source code.
|
||||
version_src_dir = build_dir / f"src_{version.name}"
|
||||
version_src_dir.mkdir()
|
||||
|
||||
# Check out the version's source code from git.
|
||||
archive_path = version_src_dir / "source.tar"
|
||||
run_command([
|
||||
"git", "archive", version.name,
|
||||
"--format=tar", f"--output={archive_path}"
|
||||
])
|
||||
run_command(["tar", "-xf", str(archive_path)], cwd=version_src_dir)
|
||||
archive_path.unlink()
|
||||
|
||||
# Configure and build the docs using CMake.
|
||||
version_build_dir = build_dir / f"build_{version.name}"
|
||||
version_build_dir.mkdir()
|
||||
run_command([ "cmake", str(version_src_dir), "-DFTXUI_BUILD_DOCS=ON", '-DFTXUI_BUILD_EXAMPLES=ON'], cwd=version_build_dir)
|
||||
run_command(["make", "doc"], cwd=version_build_dir)
|
||||
|
||||
# Copy the generated HTML files to the final destination.
|
||||
doxygen_html_dir = version_build_dir / "doc" / "doxygen" / "html"
|
||||
if not doxygen_html_dir.is_dir():
|
||||
print(f"FATAL: Doxygen HTML output not found for version {version.name}")
|
||||
exit(1)
|
||||
|
||||
print(f"Copying files to: {version.dest_dir}")
|
||||
shutil.copytree(doxygen_html_dir, version.dest_dir, dirs_exist_ok=True)
|
||||
|
||||
# --- 4. Inject version switcher into all HTML files ---
|
||||
print("\n--- Injecting version switcher JavaScript ---")
|
||||
for version in versions:
|
||||
if not version.dest_dir.exists():
|
||||
print(f"Warning: Destination directory for {version.name} does not exist. Skipping JS injection.")
|
||||
continue
|
||||
|
||||
print(f"Processing HTML files in: {version.dest_dir}")
|
||||
|
||||
html_files = []
|
||||
if version.is_main:
|
||||
# For the main version, find all HTML files, but explicitly exclude the 'en' directory.
|
||||
html_files.extend(version.dest_dir.glob("*.html"))
|
||||
for subdir in version.dest_dir.iterdir():
|
||||
if subdir.is_dir() and subdir.name != 'en':
|
||||
html_files.extend(subdir.rglob("*.html"))
|
||||
else:
|
||||
# For other versions, their directory is self-contained.
|
||||
html_files = list(version.dest_dir.rglob("*.html"))
|
||||
|
||||
for html_file in html_files:
|
||||
js_script = get_version_switcher_js(version, versions, html_file)
|
||||
script_tag = f'<script>{js_script}</script>'
|
||||
|
||||
content = html_file.read_text(encoding='utf-8')
|
||||
# Inject the script right before the closing body tag.
|
||||
new_content = content.replace("</body>", f"{script_tag}\n</body>")
|
||||
html_file.write_text(new_content, encoding='utf-8')
|
||||
|
||||
print("\n--- 5. Finalizing ---")
|
||||
print("Multi-version documentation generated successfully!")
|
||||
print(f"Output located in: {output_dir.resolve()}")
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in New Issue
Block a user