Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MultiProgressBar now buffers the output text to a single write #1825

Merged
merged 2 commits into from
Nov 8, 2024
Merged

MultiProgressBar now buffers the output text to a single write #1825

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ad9ec4
MultiProgressBar now buffers the output text to a single write
Giedriusj1 Nov 2, 2024
d216705
Optimise multi_progress_bar tty control sequences
Giedriusj1 Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions libdnf5-cli/progressbar/multi_progress_bar.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,22 @@ std::size_t MultiProgressBar::get_total_num_of_bars() const noexcept {
std::ostream & operator<<(std::ostream & stream, MultiProgressBar & mbar) {
const bool is_interactive{tty::is_interactive()};

// We'll buffer the output text to a single string and print it all at once.
// This is to avoid multiple writes to the terminal, which can cause flickering.
static std::ostringstream text_buffer;
text_buffer.str("");
text_buffer.clear();

if (is_interactive && mbar.num_of_lines_to_clear > 0) {
stream << tty::clear_line;
for (std::size_t i = 1; i < mbar.num_of_lines_to_clear; i++) {
stream << tty::cursor_up << tty::clear_line;
if (mbar.num_of_lines_to_clear > 1) {
// Move the cursor up by the number of lines we want to write over
text_buffer << "\033[" << (mbar.num_of_lines_to_clear - 1) << "A";
}
stream << "\r";
text_buffer << "\r";
} else if (mbar.line_printed) {
stream << std::endl;
text_buffer << std::endl;
}

mbar.num_of_lines_to_clear = 0;
mbar.line_printed = false;

Expand All @@ -124,8 +131,8 @@ std::ostream & operator<<(std::ostream & stream, MultiProgressBar & mbar) {
}
bar->set_number(numbers.back());
numbers.pop_back();
stream << *bar;
stream << std::endl;
text_buffer << *bar;
text_buffer << std::endl;
mbar.bars_done.push_back(bar);
// TODO(dmach): use iterator
mbar.bars_todo.erase(mbar.bars_todo.begin() + static_cast<int>(i));
Expand All @@ -148,9 +155,9 @@ std::ostream & operator<<(std::ostream & stream, MultiProgressBar & mbar) {
continue;
}
if (mbar.line_printed) {
stream << std::endl;
text_buffer << std::endl;
}
stream << *bar;
text_buffer << *bar;
mbar.line_printed = true;
mbar.num_of_lines_to_clear++;
mbar.num_of_lines_to_clear += bar->get_messages().size();
Expand Down Expand Up @@ -178,12 +185,12 @@ std::ostream & operator<<(std::ostream & stream, MultiProgressBar & mbar) {

if ((mbar.bars_all.size() >= mbar.total_bar_visible_limit) && (is_interactive || mbar.bars_todo.empty())) {
if (mbar.line_printed) {
stream << std::endl;
text_buffer << std::endl;
}
// print divider
int terminal_width = tty::get_width();
stream << std::string(static_cast<std::size_t>(terminal_width), '-');
stream << std::endl;
text_buffer << std::string(static_cast<std::size_t>(terminal_width), '-');
text_buffer << std::endl;

// print Total progress bar
mbar.total.set_number(static_cast<int>(mbar.bars_done.size()));
Expand All @@ -196,11 +203,13 @@ std::ostream & operator<<(std::ostream & stream, MultiProgressBar & mbar) {
mbar.total.set_state(ProgressBarState::SUCCESS);
}

stream << mbar.total;
stream << std::endl;
text_buffer << mbar.total;
text_buffer << std::endl;
mbar.num_of_lines_to_clear += 3;
}

stream << text_buffer.str(); // Single syscall to output all commands

return stream;
}

Expand Down
Loading