15#include <initializer_list>
44#define DEFINE_CONSOLEV2_PROPERTIES
45#define WIN32_LEAN_AND_MEAN
60#if defined(__EMSCRIPTEN__)
61#include <emscripten.h>
75 auto* screen = App::Active();
77 screen->RequestAnimationFrame();
82#if defined(__EMSCRIPTEN__)
85void ftxui_on_resize(
int columns,
int rows) {
98 App* suspended_screen_ =
nullptr;
100 const bool use_alternative_screen_;
102 bool track_mouse_ =
true;
104 std::string set_cursor_position_;
105 std::string reset_cursor_position_;
107 std::atomic<bool> quit_{
false};
108 bool installed_ =
false;
109 bool animation_requested_ =
false;
115 std::uint64_t frame_count_ = 0;
116 bool mouse_captured =
false;
117 bool previous_frame_resized_ =
false;
119 bool frame_valid_ =
false;
121 bool force_handle_ctrl_c_ =
true;
122 bool force_handle_ctrl_z_ =
true;
124 int cursor_reset_shape_ = 1;
127 bool handle_piped_input_ =
true;
128 bool is_stdin_a_tty_ =
false;
129 bool is_stdout_a_tty_ =
false;
133 std::string terminal_name_ =
"unknown";
134 int terminal_version_ = 0;
136 std::string terminal_emulator_name_ =
"unknown";
137 std::string terminal_emulator_version_ =
"unknown";
139 std::vector<int> terminal_capabilities_;
143 struct SelectionData {
149 bool operator==(
const SelectionData& other)
const {
150 if (empty && other.empty) {
153 if (empty || other.empty) {
156 return start_x == other.start_x && start_y == other.start_y &&
157 end_x == other.end_x && end_y == other.end_y;
159 bool operator!=(
const SelectionData& other)
const {
160 return !(*
this == other);
163 SelectionData selection_data_;
164 SelectionData selection_data_previous_;
165 std::unique_ptr<Selection> selection_;
166 std::function<void()> selection_on_change_;
171 TerminalInputParser terminal_input_parser;
172 task::TaskRunner task_runner;
173 std::chrono::time_point<std::chrono::steady_clock> last_char_time =
174 std::chrono::steady_clock::now();
175 std::string output_buffer;
177 class ThrottledRequest {
179 ThrottledRequest(App::Internal* internal, std::function<
void()> send)
180 : internal_(internal), send_(std::move(send)) {}
182 void Request(
bool force =
false) {
183 if (!internal_->is_stdin_a_tty_) {
198 const auto now = std::chrono::steady_clock::now();
199 const auto delta = now - last_request_time_;
200 const auto delay = std::chrono::milliseconds(500) - delta;
202 if (delay <= std::chrono::milliseconds(0)) {
207 request_queued_ =
true;
210 request_queued_ =
false;
216 void OnReply() { pending_request_ =
false; }
218 bool HasPending()
const {
219 if (pending_request_) {
220 const auto now = std::chrono::steady_clock::now();
221 if (now - last_sent_time_ < std::chrono::seconds(5)) {
225 return request_queued_;
230 last_sent_time_ = std::chrono::steady_clock::now();
231 last_request_time_ = last_sent_time_;
232 pending_request_ =
true;
236 App::Internal* internal_;
237 std::function<void()> send_;
238 bool pending_request_ =
false;
239 std::chrono::steady_clock::time_point last_request_time_ =
240 std::chrono::steady_clock::now() - std::chrono::hours(1);
241 std::chrono::steady_clock::time_point last_sent_time_ =
242 std::chrono::steady_clock::now() - std::chrono::hours(1);
243 bool request_queued_ =
false;
246 ThrottledRequest cursor_position_request;
248 MultiReceiverBuffer<Event> event_buffer;
249 std::unique_ptr<MultiReceiverBuffer<Event>::Receiver> main_loop_receiver;
251 Internal(App* app,
AppDimension dimension,
bool use_alternative_screen);
259 void RunOnce(
const Component& component);
260 void RunOnceBlocking(
Component component);
262 bool HandleSelection(
bool handled, Event event);
264 std::string ResetCursorPosition();
265 void RequestCursorPosition(
bool force =
false);
266 void TerminalSend(std::string_view);
267 void TerminalFlush();
268 void InstallPipedInputHandling();
269 void InstallTerminalInfo();
270 void Signal(
int signal);
271 size_t FetchTerminalEvents();
272 void PostAnimationTask();
277App* g_active_screen =
nullptr;
279std::stack<Closure> on_exit_functions;
282 while (!on_exit_functions.empty()) {
283 on_exit_functions.top()();
284 on_exit_functions.pop();
289const std::string CSI =
"\x1b[";
292const std::string DCS =
"\x1bP";
295const std::string ST =
"\x1b\\";
299const std::string DECRQSS_DECSCUSR = DCS +
"$q q" + ST;
302enum class DECMode : std::uint16_t {
308 kMouseVt200Highlight = 1001,
310 kMouseBtnEventMouse = 1002,
311 kMouseAnyEvent = 1003,
314 kMouseSgrExtMode = 1006,
315 kMouseUrxvtMode = 1015,
316 kMouseSgrPixelsMode = 1016,
317 kAlternateScreen = 1049,
321enum class DSRMode : std::uint8_t {
325std::string Serialize(
const std::vector<DECMode>& parameters) {
328 for (
const DECMode parameter : parameters) {
332 out += std::to_string(
int(parameter));
339std::string Set(
const std::vector<DECMode>& parameters) {
340 return CSI +
"?" + Serialize(parameters) +
"h";
344std::string Reset(
const std::vector<DECMode>& parameters) {
345 return CSI +
"?" + Serialize(parameters) +
"l";
349std::string DeviceStatusReport(DSRMode ps) {
350 return CSI + std::to_string(
int(ps)) +
"n";
353class CapturedMouseImpl :
public CapturedMouseInterface {
355 explicit CapturedMouseImpl(std::function<
void(
void)> callback)
356 : callback_(std::move(callback)) {}
357 ~CapturedMouseImpl()
override { callback_(); }
358 CapturedMouseImpl(
const CapturedMouseImpl&) =
delete;
359 CapturedMouseImpl(CapturedMouseImpl&&) =
delete;
360 CapturedMouseImpl& operator=(
const CapturedMouseImpl&) =
delete;
361 CapturedMouseImpl& operator=(CapturedMouseImpl&&) =
delete;
364 std::function<void(
void)> callback_;
368std::atomic<int> g_signal_exit_count = 0;
369std::atomic<int> g_signal_stop_count = 0;
370std::atomic<int> g_signal_resize_count = 0;
372std::atomic<int> g_signal_exit_count = 0;
377std::atomic<bool> g_terminal_is_raw{
false};
381std::atomic<int> g_last_signal{0};
384using SignalHandler = void (*)(int);
386std::map<int, SignalHandler> g_old_signal_handlers;
389DWORD g_original_stdout_mode = 0;
390DWORD g_original_stdin_mode = 0;
391bool g_has_original_console_mode =
false;
394std::map<int, struct sigaction> g_old_sigactions;
397struct termios g_original_termios;
398bool g_has_original_termios =
false;
404void RestoreSignalHandlerAndRaise(
int signal) {
406 auto it = g_old_signal_handlers.find(signal);
407 auto old_handler = (it != g_old_signal_handlers.end()) ? it->second : SIG_DFL;
408 std::signal(signal, old_handler);
410 auto it = g_old_sigactions.find(signal);
411 if (it != g_old_sigactions.end()) {
412 sigaction(signal, &it->second,
nullptr);
415 sa.sa_handler = SIG_DFL;
416 sigemptyset(&sa.sa_mask);
418 sigaction(signal, &sa,
nullptr);
426void RestoreTerminalEmergency() {
427 if (!g_terminal_is_raw.exchange(
false)) {
431 if (g_has_original_console_mode) {
432 auto stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE);
433 auto stdin_handle = GetStdHandle(STD_INPUT_HANDLE);
434 SetConsoleMode(stdout_handle, g_original_stdout_mode);
435 SetConsoleMode(stdin_handle, g_original_stdin_mode);
438 if (g_has_original_termios && g_tty_fd >= 0) {
439 const char restore_seq[] =
448 std::ignore = write(STDOUT_FILENO, restore_seq,
sizeof(restore_seq) - 1);
449 tcsetattr(g_tty_fd, TCSANOW, &g_original_termios);
455void RecordSignal(
int signal) {
472 RestoreTerminalEmergency();
473 RestoreSignalHandlerAndRaise(signal);
487 g_last_signal.store(signal);
488 g_signal_exit_count++;
494 g_signal_stop_count++;
499 g_signal_resize_count++;
508void ExecuteSignalHandlers() {
509 if (g_last_signal.load() != 0) {
510 App::Private::Signal(*g_active_screen, SIGABRT);
513 int signal_exit_count = g_signal_exit_count.exchange(0);
514 while (signal_exit_count--) {
515 App::Private::Signal(*g_active_screen, SIGABRT);
519 int signal_stop_count = g_signal_stop_count.exchange(0);
520 while (signal_stop_count--) {
521 App::Private::Signal(*g_active_screen, SIGTSTP);
524 int signal_resize_count = g_signal_resize_count.exchange(0);
525 while (signal_resize_count--) {
526 App::Private::Signal(*g_active_screen, SIGWINCH);
531void InstallSignalHandler(
int sig) {
533 auto old_signal_handler = std::signal(sig, RecordSignal);
534 g_old_signal_handlers[sig] = old_signal_handler;
535 on_exit_functions.emplace(
536 [=] { std::ignore = std::signal(sig, old_signal_handler); });
539 sa.sa_handler = RecordSignal;
540 sigemptyset(&sa.sa_mask);
541 sa.sa_flags = SA_RESTART;
542 struct sigaction old_sa;
543 sigaction(sig, &sa, &old_sa);
544 g_old_sigactions[sig] = old_sa;
545 on_exit_functions.emplace([=] { sigaction(sig, &old_sa,
nullptr); });
551App::Internal::Internal(App* app,
553 bool use_alternative_screen)
555 dimension_(dimension),
556 use_alternative_screen_(use_alternative_screen),
557 terminal_input_parser([&](Event event) {
558 event_buffer.Push(std::move(event));
560 cursor_position_request(
this, [
this] {
561 TerminalSend(DeviceStatusReport(DSRMode::kCursor));
563 main_loop_receiver = event_buffer.CreateReceiver();
566void App::Internal::ExitNow() {
570void App::Internal::Install() {
571 frame_valid_ =
false;
580 InstallPipedInputHandling();
584 on_exit_functions.emplace([
this] { TerminalFlush(); });
588 for (
const int signal : {SIGTERM, SIGSEGV, SIGINT, SIGILL, SIGABRT, SIGFPE}) {
589 InstallSignalHandler(signal);
595 auto stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE);
596 auto stdin_handle = GetStdHandle(STD_INPUT_HANDLE);
600 GetConsoleMode(stdout_handle, &out_mode);
601 GetConsoleMode(stdin_handle, &in_mode);
602 g_original_stdout_mode = out_mode;
603 g_original_stdin_mode = in_mode;
604 g_has_original_console_mode =
true;
605 on_exit_functions.push([=] { SetConsoleMode(stdout_handle, out_mode); });
606 on_exit_functions.push([=] { SetConsoleMode(stdin_handle, in_mode); });
609 const int enable_virtual_terminal_processing = 0x0004;
610 const int disable_newline_auto_return = 0x0008;
611 out_mode |= enable_virtual_terminal_processing;
612 out_mode |= disable_newline_auto_return;
615 const int enable_line_input = 0x0002;
616 const int enable_echo_input = 0x0004;
617 const int enable_virtual_terminal_input = 0x0200;
618 const int enable_window_input = 0x0008;
619 in_mode &= ~enable_echo_input;
620 in_mode &= ~enable_line_input;
621 in_mode |= enable_virtual_terminal_input;
622 in_mode |= enable_window_input;
624 SetConsoleMode(stdin_handle, in_mode);
625 SetConsoleMode(stdout_handle, out_mode);
627 for (
const int signal :
628 {SIGWINCH, SIGTSTP, SIGBUS, SIGSYS, SIGQUIT, SIGHUP}) {
629 InstallSignalHandler(signal);
632 struct termios terminal;
633 tcgetattr(tty_fd_, &terminal);
634 g_original_termios = terminal;
636 g_has_original_termios =
true;
637 on_exit_functions.emplace([terminal = terminal, tty_fd_ = tty_fd_] {
638 tcsetattr(tty_fd_, TCSANOW, &terminal);
642 terminal.c_iflag &= ~IGNBRK;
643 terminal.c_iflag &= ~BRKINT;
645 terminal.c_iflag &= ~PARMRK;
646 terminal.c_iflag &= ~ISTRIP;
647 terminal.c_iflag &= ~INLCR;
648 terminal.c_iflag &= ~IGNCR;
649 terminal.c_iflag &= ~ICRNL;
650 terminal.c_iflag &= ~IXON;
652 terminal.c_lflag &= ~ECHO;
653 terminal.c_lflag &= ~ECHONL;
654 terminal.c_lflag &= ~ICANON;
655 terminal.c_lflag &= ~ISIG;
660 terminal.c_lflag &= ~IEXTEN;
661 terminal.c_cflag |= CS8;
663 terminal.c_cc[VMIN] = 0;
665 terminal.c_cc[VTIME] = 0;
667 tcsetattr(tty_fd_, TCSANOW, &terminal);
671 auto enable = [&](
const std::vector<DECMode>& parameters) {
672 TerminalSend(Set(parameters));
673 on_exit_functions.emplace(
674 [
this, parameters] { TerminalSend(Reset(parameters)); });
677 auto disable = [&](
const std::vector<DECMode>& parameters) {
678 TerminalSend(Reset(parameters));
679 on_exit_functions.emplace(
680 [
this, parameters] { TerminalSend(Set(parameters)); });
683 if (use_alternative_screen_) {
685 DECMode::kAlternateScreen,
694 enable({DECMode::kMouseVt200});
695 enable({DECMode::kMouseAnyEvent});
696 enable({DECMode::kMouseUrxvtMode});
697 enable({DECMode::kMouseSgrExtMode});
704 InstallTerminalInfo();
711 g_terminal_is_raw =
true;
714void App::Internal::Uninstall() {
715 g_terminal_is_raw =
false;
719 if (is_stdin_a_tty_ && is_stdout_a_tty_) {
720 auto closing_receiver =
721 event_buffer.CreateReceiverAt(main_loop_receiver->index());
722 auto start = std::chrono::steady_clock::now();
723 while (cursor_position_request.HasPending()) {
724 FetchTerminalEvents();
726 while (closing_receiver->Has()) {
727 const auto event = closing_receiver->Pop();
728 if (event.is_cursor_position()) {
729 cursor_x_ =
event.cursor_x();
730 cursor_y_ =
event.cursor_y();
731 cursor_position_request.OnReply();
735 task_runner.RunUntilIdle();
737 if (std::chrono::steady_clock::now() - start >
738 std::chrono::milliseconds(400)) {
741 std::this_thread::sleep_for(std::chrono::milliseconds(10));
748void App::Internal::PreMain() {
750 if (g_active_screen) {
751 std::swap(suspended_screen_, g_active_screen);
753 suspended_screen_->internal_->TerminalSend(
754 suspended_screen_->internal_->ResetCursorPosition());
755 suspended_screen_->ResetPosition(
756 suspended_screen_->internal_->output_buffer,
758 suspended_screen_->dimx_ = 0;
759 suspended_screen_->dimy_ = 0;
762 suspended_screen_->internal_->Uninstall();
766 g_active_screen = public_;
767 g_active_screen->internal_->Install();
769 previous_animation_time_ = animation::Clock::now();
772void App::Internal::PostMain() {
774 TerminalSend(ResetCursorPosition());
776 g_active_screen =
nullptr;
779 if (suspended_screen_) {
781 public_->ResetPosition(output_buffer,
true);
785 std::swap(g_active_screen, suspended_screen_);
786 g_active_screen->internal_->Install();
793 if (!use_alternative_screen_) {
796 std::cout << std::flush;
799 int sig = g_last_signal.exchange(0);
801 RestoreSignalHandlerAndRaise(sig);
805bool App::Internal::HasQuitted() {
809void App::Internal::RunOnce(
const Component& component) {
810 const AutoReset set_component(&component_, component);
811 ExecuteSignalHandlers();
812 FetchTerminalEvents();
814 while (!quit_ && main_loop_receiver->Has()) {
815 public_->Post(main_loop_receiver->Pop());
819 const size_t executed_task = task_runner.ExecutedTasks();
820 task_runner.RunUntilIdle();
822 if (executed_task == task_runner.ExecutedTasks()) {
826 ExecuteSignalHandlers();
829 if (selection_data_previous_ != selection_data_) {
830 selection_data_previous_ = selection_data_;
831 if (selection_on_change_) {
832 selection_on_change_();
833 public_->Post(Event::Custom);
838void App::Internal::RunOnceBlocking(
Component component) {
840 const auto time_per_frame = std::chrono::microseconds(16666);
842 auto time = std::chrono::steady_clock::now();
843 const size_t executed_task = task_runner.ExecutedTasks();
846 while (executed_task == task_runner.ExecutedTasks() && !HasQuitted()) {
849 const auto now = std::chrono::steady_clock::now();
850 const auto delta = now - time;
853 if (delta < time_per_frame) {
854 const auto sleep_duration = time_per_frame - delta;
855 std::this_thread::sleep_for(sleep_duration);
860void App::Internal::HandleTask(
Component component,
Task& task) {
863 using T = std::decay_t<
decltype(arg)>;
867 if constexpr (std::is_same_v<T, Event>) {
869 if (arg.is_cursor_position()) {
870 cursor_x_ = arg.cursor_x();
871 cursor_y_ = arg.cursor_y();
872 cursor_position_request.OnReply();
876 if (arg.is_cursor_shape()) {
877 cursor_reset_shape_ = arg.cursor_shape();
881 if (arg.IsTerminalCapabilities()) {
882 terminal_capabilities_ = arg.TerminalCapabilities();
886 if (arg.IsTerminalNameVersion()) {
887 terminal_name_ = arg.TerminalName();
888 terminal_version_ = arg.TerminalVersion();
892 if (arg.IsTerminalEmulator()) {
893 terminal_emulator_name_ = arg.TerminalEmulatorName();
894 terminal_emulator_version_ = arg.TerminalEmulatorVersion();
898 if (arg.is_mouse()) {
899 arg.mouse().x -= cursor_x_;
900 arg.mouse().y -= cursor_y_;
903 arg.screen_ = public_;
905 bool handled = component->OnEvent(arg);
906 handled = HandleSelection(handled, arg);
908 if (arg == Event::CtrlC && (!handled || force_handle_ctrl_c_)) {
909 RecordSignal(SIGINT);
913 if (arg == Event::CtrlZ && (!handled || force_handle_ctrl_z_)) {
914 RecordSignal(SIGTSTP);
918 frame_valid_ =
false;
923 if constexpr (std::is_same_v<T, Closure>) {
929 if constexpr (std::is_same_v<T, AnimationTask>) {
930 if (!animation_requested_) {
934 animation_requested_ =
false;
937 previous_animation_time_ = now;
939 animation::Params params(delta);
940 component->OnAnimation(params);
941 frame_valid_ =
false;
949bool App::Internal::HandleSelection(
bool handled, Event event) {
951 selection_pending_ =
nullptr;
952 selection_data_.empty =
true;
953 selection_ =
nullptr;
957 if (!event.is_mouse()) {
961 auto& mouse =
event.mouse();
962 if (mouse.button != Mouse::Left) {
966 if (mouse.motion == Mouse::Pressed) {
967 selection_pending_ = public_->CaptureMouse();
968 selection_data_.start_x = mouse.x;
969 selection_data_.start_y = mouse.y;
970 selection_data_.end_x = mouse.x;
971 selection_data_.end_y = mouse.y;
975 if (!selection_pending_) {
979 if (mouse.motion == Mouse::Moved) {
980 if ((mouse.x != selection_data_.end_x) ||
981 (mouse.y != selection_data_.end_y)) {
982 selection_data_.end_x = mouse.x;
983 selection_data_.end_y = mouse.y;
984 selection_data_.empty =
false;
990 if (mouse.motion == Mouse::Released) {
991 selection_pending_ =
nullptr;
992 selection_data_.end_x = mouse.x;
993 selection_data_.end_y = mouse.y;
994 selection_data_.empty =
false;
1001void App::Internal::Draw(
Component component) {
1005 auto document = component->Render();
1009 document->ComputeRequirement();
1010 switch (dimension_) {
1012 dimx = public_->dimx_;
1013 dimy = public_->dimy_;
1016 dimx = terminal.dimx;
1017 dimy =
util::clamp(document->requirement().min_y, 0, terminal.dimy);
1020 dimx = terminal.dimx;
1021 dimy = terminal.dimy;
1024 dimx =
util::clamp(document->requirement().min_x, 0, terminal.dimx);
1025 dimy =
util::clamp(document->requirement().min_y, 0, terminal.dimy);
1030 TerminalSend(
"\033[?25l");
1032 const bool resized =
1033 frame_count_ == 0 || (dimx != public_->dimx_) || (dimy != public_->dimy_);
1034 TerminalSend(ResetCursorPosition());
1036 if (frame_count_ != 0) {
1039 public_->ResetPosition(output_buffer, resized);
1043 if ((dimx < public_->dimx_) && !use_alternative_screen_) {
1044 TerminalSend(
"\033[J");
1045 TerminalSend(
"\033[H");
1051 public_->dimx_ = dimx;
1052 public_->dimy_ = dimy;
1053 public_->cells_ = std::vector<Cell>(
static_cast<size_t>(dimx) *
1054 static_cast<size_t>(dimy));
1055 Cursor cursor = public_->cursor_;
1056 cursor.x = dimx - 1;
1057 cursor.y = dimy - 1;
1058 public_->SetCursor(cursor);
1064 if (!use_alternative_screen_ && is_stdout_a_tty_) {
1065 RequestCursorPosition(previous_frame_resized_);
1067 previous_frame_resized_ = resized;
1069 selection_ = selection_data_.empty
1070 ? std::make_unique<Selection>()
1071 : std::make_unique<Selection>(
1072 selection_data_.start_x, selection_data_.start_y,
1073 selection_data_.end_x, selection_data_.end_y);
1074 Render(*public_, document.get(), *selection_);
1078 const int dx = public_->dimx_ - 1 - public_->cursor_.x +
1079 int(public_->dimx_ != terminal.dimx);
1080 const int dy = public_->dimy_ - 1 - public_->cursor_.y;
1082 set_cursor_position_.clear();
1083 reset_cursor_position_.clear();
1086 set_cursor_position_ +=
"\x1B[" + std::to_string(dy) +
"A";
1087 reset_cursor_position_ +=
"\x1B[" + std::to_string(dy) +
"B";
1091 set_cursor_position_ +=
"\x1B[" + std::to_string(dx) +
"D";
1092 reset_cursor_position_ +=
"\x1B[" + std::to_string(dx) +
"C";
1095 if (public_->cursor_.shape != Screen::Cursor::Hidden) {
1096 set_cursor_position_ +=
"\033[?25h";
1097 set_cursor_position_ +=
1098 "\033[" + std::to_string(
int(public_->cursor_.shape)) +
" q";
1102 public_->ToString(output_buffer);
1103 TerminalSend(set_cursor_position_);
1107 frame_valid_ =
true;
1111std::string App::Internal::ResetCursorPosition() {
1112 std::string result = std::move(reset_cursor_position_);
1113 reset_cursor_position_ =
"";
1117void App::Internal::RequestCursorPosition(
bool force) {
1118 cursor_position_request.Request(force);
1121void App::Internal::TerminalSend(std::string_view s) {
1125void App::Internal::TerminalFlush() {
1127 output_buffer +=
'\0';
1128 std::cout << output_buffer << std::flush;
1129 output_buffer.clear();
1132void App::Internal::InstallPipedInputHandling() {
1133 is_stdin_a_tty_ =
false;
1134 is_stdout_a_tty_ =
false;
1135#if defined(__EMSCRIPTEN__)
1136 is_stdin_a_tty_ =
true;
1137 is_stdout_a_tty_ =
true;
1138#elif defined(_WIN32)
1139 is_stdin_a_tty_ = _isatty(_fileno(stdin));
1140 is_stdout_a_tty_ = _isatty(_fileno(stdout));
1142 tty_fd_ = STDIN_FILENO;
1143 is_stdout_a_tty_ = isatty(STDOUT_FILENO);
1147 if (!handle_piped_input_) {
1148 is_stdin_a_tty_ = isatty(STDIN_FILENO);
1149 }
else if (isatty(STDIN_FILENO)) {
1150 is_stdin_a_tty_ =
true;
1153 tty_fd_ = open(
"/dev/tty", O_RDONLY);
1156 tty_fd_ = STDIN_FILENO;
1157 is_stdin_a_tty_ = isatty(STDIN_FILENO);
1159 is_stdin_a_tty_ =
true;
1161 on_exit_functions.emplace([
this] {
1170void App::Internal::InstallTerminalInfo() {
1173 if (is_stdout_a_tty_) {
1174 TerminalSend(DECRQSS_DECSCUSR);
1175 TerminalSend(
"\033[>q");
1176 TerminalSend(
"\033[>c");
1177 TerminalSend(
"\033[c");
1182 if (is_stdin_a_tty_ && is_stdout_a_tty_) {
1186 auto setup_receiver = event_buffer.CreateReceiver();
1187 auto start = std::chrono::steady_clock::now();
1188 bool terminal_capabilities_received =
false;
1191 FetchTerminalEvents();
1192 while (setup_receiver->Has()) {
1193 const auto event = setup_receiver->Pop();
1194 if (event.is_cursor_shape()) {
1195 cursor_reset_shape_ =
event.cursor_shape();
1198 if (event.IsTerminalCapabilities()) {
1199 terminal_capabilities_ =
event.TerminalCapabilities();
1200 terminal_capabilities_received =
true;
1203 if (event.IsTerminalNameVersion()) {
1204 terminal_name_ =
event.TerminalName();
1205 terminal_version_ =
event.TerminalVersion();
1208 if (event.IsTerminalEmulator()) {
1209 terminal_emulator_name_ =
event.TerminalEmulatorName();
1210 terminal_emulator_version_ =
event.TerminalEmulatorVersion();
1217 if (terminal_capabilities_received) {
1221 if (std::chrono::steady_clock::now() - start >
1222 std::chrono::milliseconds(500)) {
1225 std::this_thread::sleep_for(std::chrono::milliseconds(10));
1232 auto safe_getenv = [](
const char* name) -> std::string_view {
1233 const char*
value = std::getenv(name);
1238 safe_getenv(
"TERM"), safe_getenv(
"COLORTERM"),
1239 safe_getenv(
"TERM_PROGRAM"), terminal_name_, terminal_emulator_name_,
1240 terminal_capabilities_);
1242 quirks.SetColorSupport(color_support);
1244 const bool is_modern_emulator = (terminal_emulator_name_ !=
"unknown");
1245 const bool is_vt220_plus =
1246 (terminal_name_ !=
"vt100" && terminal_name_ !=
"unknown");
1247 bool reports_utf8 =
false;
1248 for (
const int x : terminal_capabilities_) {
1250 reports_utf8 =
true;
1261 bool modern = is_modern_emulator || is_vt220_plus || reports_utf8;
1263 quirks.SetBlockCharacters(
true);
1264 quirks.SetCursorHiding(
true);
1265 quirks.SetComponentAscii(
false);
1270 on_exit_functions.emplace([
this] {
1271 TerminalSend(
"\033[?25h");
1272 if (is_stdout_a_tty_) {
1273 TerminalSend(
"\033[" + std::to_string(cursor_reset_shape_) +
" q");
1278void App::Internal::Signal(
int signal) {
1279 if (signal == SIGABRT) {
1286 if (signal == SIGTSTP) {
1288 TerminalSend(ResetCursorPosition());
1289 public_->ResetPosition(output_buffer,
true);
1293 (void)std::raise(SIGTSTP);
1299 if (signal == SIGWINCH) {
1300 public_->Post(Event::Special({0}));
1306size_t App::Internal::FetchTerminalEvents() {
1308 auto get_input_records = [&]() -> std::vector<INPUT_RECORD> {
1310 auto console = GetStdHandle(STD_INPUT_HANDLE);
1311 DWORD number_of_events = 0;
1312 if (!GetNumberOfConsoleInputEvents(console, &number_of_events)) {
1313 return std::vector<INPUT_RECORD>();
1315 if (number_of_events <= 0) {
1317 return std::vector<INPUT_RECORD>();
1320 std::vector<INPUT_RECORD> records(number_of_events);
1321 DWORD number_of_events_read = 0;
1322 if (!ReadConsoleInput(console, records.data(), (DWORD)records.size(),
1323 &number_of_events_read)) {
1324 return std::vector<INPUT_RECORD>();
1326 records.resize(number_of_events_read);
1330 auto records = get_input_records();
1331 if (records.size() == 0) {
1332 const auto timeout = std::chrono::steady_clock::now() - last_char_time;
1333 const size_t timeout_microseconds =
1334 std::chrono::duration_cast<std::chrono::microseconds>(timeout).count();
1335 terminal_input_parser.Timeout(timeout_microseconds);
1338 last_char_time = std::chrono::steady_clock::now();
1343 std::wstring wstring;
1344 for (
const auto& r : records) {
1345 switch (r.EventType) {
1347 auto key_event = r.Event.KeyEvent;
1349 if (key_event.bKeyDown == FALSE) {
1352 const wchar_t wc = key_event.uChar.UnicodeChar;
1354 if (wc >= 0xd800 && wc <= 0xdbff) {
1359 terminal_input_parser.Add(it);
1363 case WINDOW_BUFFER_SIZE_EVENT:
1364 public_->Post(Event::Special({0}));
1373 return records.size();
1374#elif defined(__EMSCRIPTEN__)
1377 std::array<char, 128> out{};
1378 const ssize_t l = read(STDIN_FILENO, out.data(), out.size());
1380 const auto timeout = std::chrono::steady_clock::now() - last_char_time;
1381 const size_t timeout_microseconds =
1382 std::chrono::duration_cast<std::chrono::microseconds>(timeout).count();
1383 terminal_input_parser.Timeout(timeout_microseconds);
1386 last_char_time = std::chrono::steady_clock::now();
1389 for (ssize_t i = 0; i < l; ++i) {
1390 terminal_input_parser.Add(out.at(
static_cast<size_t>(i)));
1394 struct pollfd pfd = {tty_fd_, POLLIN, 0};
1395 const int poll_result = poll(&pfd, 1, 0);
1396 if (poll_result <= 0) {
1397 const auto timeout = std::chrono::steady_clock::now() - last_char_time;
1398 const size_t timeout_ms =
1399 std::chrono::duration_cast<std::chrono::milliseconds>(timeout).count();
1400 terminal_input_parser.Timeout(
static_cast<int>(timeout_ms));
1403 last_char_time = std::chrono::steady_clock::now();
1406 std::array<char, 128> out{};
1407 const ssize_t l = read(tty_fd_, out.data(), out.size());
1413 for (ssize_t i = 0; i < l; ++i) {
1414 terminal_input_parser.Add(out.at(
static_cast<size_t>(i)));
1420void App::Internal::PostAnimationTask() {
1421 public_->Post(AnimationTask());
1425 task_runner.PostDelayedTask([
this] { PostAnimationTask(); },
1426 std::chrono::milliseconds(15));
1429App::App(std::unique_ptr<Internal> internal,
int dimx,
int dimy)
1430 : Screen(dimx, dimy), internal_(std::move(internal)) {
1431 internal_->public_ =
this;
1434App::App(App&& other) noexcept : Screen(std::move(other)) {
1435 internal_ = std::move(other.internal_);
1437 internal_->public_ =
this;
1441App& App::operator=(App&& other)
noexcept {
1442 Screen::operator=(std::move(other));
1443 internal_ = std::move(other.internal_);
1445 internal_->public_ =
this;
1450App::~App() =
default;
1453App App::FixedSize(
int dimx,
int dimy) {
1456 return App(std::move(internal), dimx, dimy);
1460App App::Fullscreen() {
1461 return FullscreenAlternateScreen();
1465App App::FullscreenPrimaryScreen() {
1469 return App(std::move(internal), terminal.dimx, terminal.dimy);
1473App App::FullscreenAlternateScreen() {
1477 return App(std::move(internal), terminal.dimx, terminal.dimy);
1481App App::FitComponent() {
1485 return App(std::move(internal), terminal.dimx, terminal.dimy);
1489App App::TerminalOutput() {
1493 return App(std::move(internal), terminal.dimx, terminal.dimy);
1496void App::TrackMouse(
bool enable) {
1497 internal_->track_mouse_ = enable;
1500void App::HandlePipedInput(
bool enable) {
1501 internal_->handle_piped_input_ = enable;
1506 return g_active_screen;
1510 class Loop loop(this, std::move(component));
1515 Post([
this] { internal_->ExitNow(); });
1518Closure App::ExitLoopClosure() {
1519 return [
this] { Exit(); };
1522void App::Post(
Task task) {
1523 internal_->task_runner.PostTask([
this, task = std::move(task)]()
mutable {
1524 if (internal_->component_) {
1525 internal_->HandleTask(internal_->component_, task);
1530 if (std::holds_alternative<Closure>(task)) {
1531 std::get<Closure>(task)();
1536void App::PostEvent(Event event) {
1539 Post(
Task(std::move(event)));
1543void App::PostEventOrExecute(
Closure closure) {
1547 if (
auto* app = App::Active()) {
1548 app->Post(std::move(closure));
1554void App::RequestAnimationFrame() {
1555 if (internal_->animation_requested_) {
1558 internal_->animation_requested_ =
true;
1559 auto now = animation::Clock::now();
1560 const auto time_histeresis = std::chrono::milliseconds(33);
1561 if (now - internal_->previous_animation_time_ >= time_histeresis) {
1562 internal_->previous_animation_time_ = now;
1567 if (internal_->mouse_captured) {
1570 internal_->mouse_captured =
true;
1571 return std::make_unique<CapturedMouseImpl>(
1572 [
this] { internal_->mouse_captured =
false; });
1577 internal_->Uninstall();
1579 internal_->Install();
1583void App::ForceHandleCtrlC(
bool force) {
1584 internal_->force_handle_ctrl_c_ = force;
1587void App::ForceHandleCtrlZ(
bool force) {
1588 internal_->force_handle_ctrl_z_ = force;
1591std::string App::GetSelection() {
1592 if (!internal_->selection_) {
1595 return internal_->selection_->GetParts();
1598void App::SelectionChange(std::function<
void()> callback) {
1599 internal_->selection_on_change_ = std::move(callback);
1602const std::string& App::TerminalName()
const {
1603 return internal_->terminal_name_;
1606int App::TerminalVersion()
const {
1607 return internal_->terminal_version_;
1610const std::string& App::TerminalEmulatorName()
const {
1611 return internal_->terminal_emulator_name_;
1614const std::string& App::TerminalEmulatorVersion()
const {
1615 return internal_->terminal_emulator_version_;
1618const std::vector<int>& App::TerminalCapabilities()
const {
1619 return internal_->terminal_capabilities_;
1622std::vector<std::string> App::TerminalCapabilityNames()
const {
1623 return Event::TerminalCapabilities(
"", internal_->terminal_capabilities_)
1624 .TerminalCapabilityNames();
1629void App::ExitNow() {
1630 internal_->ExitNow();
1632void App::Install() {
1633 internal_->Install();
1635void App::Uninstall() {
1636 internal_->Uninstall();
1638void App::PreMain() {
1639 internal_->PreMain();
1641void App::PostMain() {
1642 internal_->PostMain();
1644bool App::HasQuitted() {
1645 return internal_->HasQuitted();
1647void App::RunOnce(
const Component& component) {
1648 internal_->RunOnce(component);
1650void App::RunOnceBlocking(
Component component) {
1651 internal_->RunOnceBlocking(component);
1654 internal_->HandleTask(component, task);
1656bool App::HandleSelection(
bool handled, Event event) {
1657 return internal_->HandleSelection(handled, event);
1660 internal_->Draw(component);
1662std::string App::ResetCursorPosition() {
1663 return internal_->ResetCursorPosition();
1665void App::RequestCursorPosition(
bool force) {
1666 internal_->RequestCursorPosition(force);
1668void App::TerminalSend(std::string_view s) {
1669 internal_->TerminalSend(s);
1671void App::TerminalFlush() {
1672 internal_->TerminalFlush();
1674void App::InstallPipedInputHandling() {
1675 internal_->InstallPipedInputHandling();
1677void App::InstallTerminalInfo() {
1678 internal_->InstallTerminalInfo();
1680void App::Signal(
int signal) {
1681 internal_->Signal(signal);
1683size_t App::FetchTerminalEvents() {
1684 return internal_->FetchTerminalEvents();
1686void App::PostAnimationTask() {
1687 internal_->PostAnimationTask();
1690Loop::Loop(App* screen,
Component component)
1691 : screen_(screen), component_(std::move(component)) {
1696 screen_->PostMain();
1699bool Loop::HasQuitted() {
1700 return screen_->HasQuitted();
1703void Loop::RunOnce() {
1704 screen_->RunOnce(component_);
1707void Loop::RunOnceBlocking() {
1708 screen_->RunOnceBlocking(component_);
1712 while (!HasQuitted()) {
auto PostDelayedTask(Task task, std::chrono::steady_clock::duration duration) -> void
Schedules a task to be executed after a certain duration.
Quirks GetQuirks()
Get the terminal quirks.
Dimensions Size()
Get the terminal size.
void SetQuirks(const Quirks &quirks)
Override terminal quirks.
The FTXUI ftxui::animation:: namespace.
void SetFallbackSize(const Dimensions &fallbackSize)
Override terminal size in case auto-detection fails.
Color ComputeColorSupport(std::string_view term, std::string_view colorterm, std::string_view term_program, std::string_view terminal_name, std::string_view terminal_emulator_name, const std::vector< int > &capabilities)
Compute the color support based on environment variables and terminal identification.
std::chrono::duration< float > Duration
std::chrono::time_point< Clock > TimePoint
void RequestAnimationFrame()
constexpr const T & clamp(const T &v, const T &lo, const T &hi)
The FTXUI ftxui:: namespace.
std::unique_ptr< CapturedMouseInterface > CapturedMouse
std::string to_string(std::wstring_view s)
Convert a std::wstring into a UTF8 std::string.
std::variant< Event, Closure, AnimationTask > Task
void Render(Screen &screen, Node *node, Selection &selection)
std::function< void()> Closure
std::shared_ptr< ComponentBase > Component