3 Commits

Author SHA1 Message Date
ArthurSonzogni
dad2eaaa28 Tweak implementation and documentation. 2025-08-17 19:19:06 +02:00
ArthurSonzogni
5c3e3151a5 Update doc 2025-08-17 17:21:24 +02:00
Harri Pehkonen
143b24c6a5 Add opt-in piped input support for POSIX systems
Enables applications to read piped data while maintaining interactive
keyboard input by redirecting stdin to /dev/tty when explicitly enabled.
2025-08-17 14:08:51 +02:00
4 changed files with 35 additions and 35 deletions

View File

@@ -169,15 +169,13 @@ ftxui_cc_library(
"src/ftxui/component/util.cpp", "src/ftxui/component/util.cpp",
"src/ftxui/component/window.cpp", "src/ftxui/component/window.cpp",
# Private header from ftxui:dom. # Private header from ftxui:dom.
"src/ftxui/dom/node_decorator.hpp", "src/ftxui/dom/node_decorator.hpp",
# Private header from ftxui:screen. # Private header from ftxui:screen.
"src/ftxui/screen/string_internal.hpp", "src/ftxui/screen/string_internal.hpp",
"src/ftxui/screen/util.hpp", "src/ftxui/screen/util.hpp",
# Private header.
"include/ftxui/util/warn_windows_macro.hpp",
], ],
hdrs = [ hdrs = [
"include/ftxui/component/animation.hpp", "include/ftxui/component/animation.hpp",

View File

@@ -27,12 +27,6 @@ Next
- Remove dependency on 'pthread'. - Remove dependency on 'pthread'.
### Component ### 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 - Fix ScreenInteractive::FixedSize screen stomps on the preceding terminal
output. Thanks @zozowell in #1064. output. Thanks @zozowell in #1064.

View File

@@ -147,8 +147,6 @@ class ScreenInteractive : public Screen {
// Piped input handling state (POSIX only) // Piped input handling state (POSIX only)
bool handle_piped_input_ = true; 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. // The style of the cursor to restore on exit.
int cursor_reset_shape_ = 1; int cursor_reset_shape_ = 1;

View File

@@ -112,13 +112,13 @@ void ftxui_on_resize(int columns, int rows) {
#else // POSIX (Linux & Mac) #else // POSIX (Linux & Mac)
int CheckStdinReady(int fd) { int CheckStdinReady() {
timeval tv = {0, 0}; // NOLINT timeval tv = {0, 0}; // NOLINT
fd_set fds; fd_set fds;
FD_ZERO(&fds); // NOLINT FD_ZERO(&fds); // NOLINT
FD_SET(fd, &fds); // NOLINT FD_SET(STDIN_FILENO, &fds); // NOLINT
select(fd + 1, &fds, nullptr, nullptr, &tv); // NOLINT select(STDIN_FILENO + 1, &fds, nullptr, nullptr, &tv); // NOLINT
return FD_ISSET(fd, &fds); // NOLINT return FD_ISSET(STDIN_FILENO, &fds); // NOLINT
} }
#endif #endif
@@ -539,8 +539,6 @@ void ScreenInteractive::Install() {
// https://github.com/ArthurSonzogni/FTXUI/issues/846 // https://github.com/ArthurSonzogni/FTXUI/issues/846
Flush(); Flush();
InstallPipedInputHandling();
// After uninstalling the new configuration, flush it to the terminal to // After uninstalling the new configuration, flush it to the terminal to
// ensure it is fully applied: // ensure it is fully applied:
on_exit_functions.emplace([] { Flush(); }); on_exit_functions.emplace([] { Flush(); });
@@ -606,10 +604,9 @@ void ScreenInteractive::Install() {
} }
struct termios terminal; // NOLINT struct termios terminal; // NOLINT
tcgetattr(tty_fd_, &terminal); tcgetattr(STDIN_FILENO, &terminal);
on_exit_functions.emplace([terminal = terminal, tty_fd_ = tty_fd_] { on_exit_functions.emplace(
tcsetattr(tty_fd_, TCSANOW, &terminal); [=] { tcsetattr(STDIN_FILENO, TCSANOW, &terminal); });
});
// Enabling raw terminal input mode // Enabling raw terminal input mode
terminal.c_iflag &= ~IGNBRK; // Disable ignoring break condition terminal.c_iflag &= ~IGNBRK; // Disable ignoring break condition
@@ -637,7 +634,7 @@ void ScreenInteractive::Install() {
// read. // read.
terminal.c_cc[VTIME] = 0; // Timeout in deciseconds for non-canonical read. terminal.c_cc[VTIME] = 0; // Timeout in deciseconds for non-canonical read.
tcsetattr(tty_fd_, TCSANOW, &terminal); tcsetattr(STDIN_FILENO, TCSANOW, &terminal);
#endif #endif
@@ -673,13 +670,20 @@ void ScreenInteractive::Install() {
// ensure it is fully applied: // ensure it is fully applied:
Flush(); Flush();
// Redirect the true terminal to stdin, so that we can read keyboard input
// directly from stdin, even if the input is piped from a file or another
// process.
//
// TODO: Instead of redirecting stdin, we could define the file descriptor to
// read from, and use it in the TerminalInputParser.
InstallPipedInputHandling();
quit_ = false; quit_ = false;
PostAnimationTask(); PostAnimationTask();
} }
void ScreenInteractive::InstallPipedInputHandling() { void ScreenInteractive::InstallPipedInputHandling() {
tty_fd_ = fileno(stdin); // NOLINT
#if !defined(_WIN32) && !defined(__EMSCRIPTEN__) #if !defined(_WIN32) && !defined(__EMSCRIPTEN__)
// Handle piped input redirection if explicitly enabled by the application. // Handle piped input redirection if explicitly enabled by the application.
// This allows applications to read data from stdin while still receiving // This allows applications to read data from stdin while still receiving
@@ -688,23 +692,29 @@ void ScreenInteractive::InstallPipedInputHandling() {
return; return;
} }
// If stdin is a terminal, we don't need to open /dev/tty. // If stdin is a terminal, we don't need to redirect it.
if (isatty(fileno(stdin))) { if (isatty(STDIN_FILENO)) {
return; return;
} }
// Open /dev/tty for keyboard input. // Save the current stdin so we can restore it later.
tty_fd_ = open("/dev/tty", O_RDONLY); int original_fd = dup(STDIN_FILENO);
if (tty_fd_ < 0) { if (original_fd < 0) {
return;
}
// Redirect stdin to the controlling terminal for keyboard input.
if (std::freopen("/dev/tty", "r", stdin) == nullptr) {
// Failed to open /dev/tty (containers, headless systems, etc.) // Failed to open /dev/tty (containers, headless systems, etc.)
tty_fd_ = fileno(stdin); // Fallback to stdin. // Clean up and continue without redirection
close(original_fd);
return; return;
} }
// Close the /dev/tty file descriptor on exit. // Restore the original stdin file descriptor on exit.
on_exit_functions.emplace([this] { on_exit_functions.emplace([=] {
close(tty_fd_); dup2(original_fd, STDIN_FILENO);
tty_fd_ = -1; close(original_fd);
}); });
#endif #endif
} }
@@ -1142,7 +1152,7 @@ void ScreenInteractive::FetchTerminalEvents() {
internal_->terminal_input_parser.Add(out[i]); internal_->terminal_input_parser.Add(out[i]);
} }
#else // POSIX (Linux & Mac) #else // POSIX (Linux & Mac)
if (!CheckStdinReady(tty_fd_)) { if (!CheckStdinReady()) {
const auto timeout = const auto timeout =
std::chrono::steady_clock::now() - internal_->last_char_time; std::chrono::steady_clock::now() - internal_->last_char_time;
const size_t timeout_ms = const size_t timeout_ms =
@@ -1154,7 +1164,7 @@ void ScreenInteractive::FetchTerminalEvents() {
// Read chars from the terminal. // Read chars from the terminal.
std::array<char, 128> out{}; std::array<char, 128> out{};
size_t l = read(tty_fd_, out.data(), out.size()); size_t l = read(fileno(stdin), out.data(), out.size());
// Convert the chars to events. // Convert the chars to events.
for (size_t i = 0; i < l; ++i) { for (size_t i = 0; i < l; ++i) {