mirror of
https://github.com/p-ranav/indicators.git
synced 2025-12-14 11:18:51 +08:00
362 lines
14 KiB
C++
362 lines
14 KiB
C++
|
|
#ifndef INDICATORS_PROGRESS_BAR
|
|
#define INDICATORS_PROGRESS_BAR
|
|
|
|
#include <indicators/details/stream_helper.hpp>
|
|
|
|
#include <algorithm>
|
|
#include <atomic>
|
|
#include <chrono>
|
|
#include <cmath>
|
|
#include <indicators/color.hpp>
|
|
#include <indicators/setting.hpp>
|
|
#include <indicators/terminal_size.hpp>
|
|
#include <iomanip>
|
|
#include <iostream>
|
|
#include <sstream>
|
|
#include <mutex>
|
|
#include <string>
|
|
#include <thread>
|
|
#include <tuple>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
namespace indicators {
|
|
|
|
class ProgressBar {
|
|
using Settings =
|
|
std::tuple<option::BarWidth, option::PrefixText, option::PostfixText,
|
|
option::Start, option::End, option::Fill, option::Lead,
|
|
option::Remainder, option::MaxPostfixTextLen,
|
|
option::Completed, option::ShowPercentage,
|
|
option::ShowElapsedTime, option::ShowRemainingTime,
|
|
option::SavedStartTime, option::ForegroundColor,
|
|
option::FontStyles, option::MinProgress, option::MaxProgress,
|
|
option::ProgressType, option::Stream>;
|
|
|
|
public:
|
|
template <typename... Args,
|
|
typename std::enable_if<
|
|
details::are_settings_from_tuple<
|
|
Settings, typename std::decay<Args>::type...>::value,
|
|
void *>::type = nullptr>
|
|
explicit ProgressBar(Args &&... args)
|
|
: settings_(
|
|
details::get<details::ProgressBarOption::bar_width>(
|
|
option::BarWidth{100}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::prefix_text>(
|
|
option::PrefixText{}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::postfix_text>(
|
|
option::PostfixText{}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::start>(
|
|
option::Start{"["}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::end>(
|
|
option::End{"]"}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::fill>(
|
|
option::Fill{"="}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::lead>(
|
|
option::Lead{">"}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::remainder>(
|
|
option::Remainder{" "}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::max_postfix_text_len>(
|
|
option::MaxPostfixTextLen{0}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::completed>(
|
|
option::Completed{false}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::show_percentage>(
|
|
option::ShowPercentage{false}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::show_elapsed_time>(
|
|
option::ShowElapsedTime{false}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::show_remaining_time>(
|
|
option::ShowRemainingTime{false}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::saved_start_time>(
|
|
option::SavedStartTime{false}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::foreground_color>(
|
|
option::ForegroundColor{Color::unspecified},
|
|
std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::font_styles>(
|
|
option::FontStyles{std::vector<FontStyle>{}},
|
|
std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::min_progress>(
|
|
option::MinProgress{0}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::max_progress>(
|
|
option::MaxProgress{100}, std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::progress_type>(
|
|
option::ProgressType{ProgressType::incremental},
|
|
std::forward<Args>(args)...),
|
|
details::get<details::ProgressBarOption::stream>(
|
|
option::Stream{std::cout}, std::forward<Args>(args)...)) {
|
|
|
|
// if progress is incremental, start from min_progress
|
|
// else start from max_progress
|
|
const auto type = get_value<details::ProgressBarOption::progress_type>();
|
|
if (type == ProgressType::incremental)
|
|
progress_ = get_value<details::ProgressBarOption::min_progress>();
|
|
else
|
|
progress_ = get_value<details::ProgressBarOption::max_progress>();
|
|
}
|
|
|
|
template <typename T, details::ProgressBarOption id>
|
|
void set_option(details::Setting<T, id> &&setting) {
|
|
static_assert(
|
|
!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
|
std::declval<Settings>()))>::type>::value,
|
|
"Setting has wrong type!");
|
|
std::lock_guard<std::mutex> lock(mutex_);
|
|
get_value<id>() = std::move(setting).value;
|
|
}
|
|
|
|
template <typename T, details::ProgressBarOption id>
|
|
void set_option(const details::Setting<T, id> &setting) {
|
|
static_assert(
|
|
!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
|
std::declval<Settings>()))>::type>::value,
|
|
"Setting has wrong type!");
|
|
std::lock_guard<std::mutex> lock(mutex_);
|
|
get_value<id>() = setting.value;
|
|
}
|
|
|
|
void
|
|
set_option(const details::Setting<
|
|
std::string, details::ProgressBarOption::postfix_text> &setting) {
|
|
std::lock_guard<std::mutex> lock(mutex_);
|
|
get_value<details::ProgressBarOption::postfix_text>() = setting.value;
|
|
if (setting.value.length() >
|
|
get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
|
get_value<details::ProgressBarOption::max_postfix_text_len>() =
|
|
setting.value.length();
|
|
}
|
|
}
|
|
|
|
void set_option(
|
|
details::Setting<std::string, details::ProgressBarOption::postfix_text>
|
|
&&setting) {
|
|
std::lock_guard<std::mutex> lock(mutex_);
|
|
get_value<details::ProgressBarOption::postfix_text>() =
|
|
std::move(setting).value;
|
|
auto &new_value = get_value<details::ProgressBarOption::postfix_text>();
|
|
if (new_value.length() >
|
|
get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
|
get_value<details::ProgressBarOption::max_postfix_text_len>() =
|
|
new_value.length();
|
|
}
|
|
}
|
|
|
|
void set_progress(size_t new_progress) {
|
|
{
|
|
std::lock_guard<std::mutex> lock(mutex_);
|
|
progress_ = new_progress;
|
|
}
|
|
|
|
save_start_time();
|
|
print_progress();
|
|
}
|
|
|
|
void tick() {
|
|
{
|
|
std::lock_guard<std::mutex> lock{mutex_};
|
|
const auto type = get_value<details::ProgressBarOption::progress_type>();
|
|
if (type == ProgressType::incremental)
|
|
progress_ += 1;
|
|
else
|
|
progress_ -= 1;
|
|
}
|
|
save_start_time();
|
|
print_progress();
|
|
}
|
|
|
|
size_t current() {
|
|
std::lock_guard<std::mutex> lock{mutex_};
|
|
return (std::min)(
|
|
progress_,
|
|
size_t(get_value<details::ProgressBarOption::max_progress>()));
|
|
}
|
|
|
|
bool is_completed() const {
|
|
return get_value<details::ProgressBarOption::completed>();
|
|
}
|
|
|
|
void mark_as_completed() {
|
|
get_value<details::ProgressBarOption::completed>() = true;
|
|
print_progress();
|
|
}
|
|
|
|
private:
|
|
template <details::ProgressBarOption id>
|
|
auto get_value()
|
|
-> decltype((details::get_value<id>(std::declval<Settings &>()).value)) {
|
|
return details::get_value<id>(settings_).value;
|
|
}
|
|
|
|
template <details::ProgressBarOption id>
|
|
auto get_value() const -> decltype(
|
|
(details::get_value<id>(std::declval<const Settings &>()).value)) {
|
|
return details::get_value<id>(settings_).value;
|
|
}
|
|
|
|
size_t progress_{0};
|
|
Settings settings_;
|
|
std::chrono::nanoseconds elapsed_;
|
|
std::chrono::time_point<std::chrono::high_resolution_clock> start_time_point_;
|
|
std::mutex mutex_;
|
|
|
|
template <typename Indicator, size_t count> friend class MultiProgress;
|
|
template <typename Indicator> friend class DynamicProgress;
|
|
std::atomic<bool> multi_progress_mode_{false};
|
|
|
|
void save_start_time() {
|
|
auto &show_elapsed_time =
|
|
get_value<details::ProgressBarOption::show_elapsed_time>();
|
|
auto &saved_start_time =
|
|
get_value<details::ProgressBarOption::saved_start_time>();
|
|
auto &show_remaining_time =
|
|
get_value<details::ProgressBarOption::show_remaining_time>();
|
|
if ((show_elapsed_time || show_remaining_time) && !saved_start_time) {
|
|
start_time_point_ = std::chrono::high_resolution_clock::now();
|
|
saved_start_time = true;
|
|
}
|
|
}
|
|
|
|
std::pair<std::string, int> get_prefix_text() {
|
|
std::stringstream os;
|
|
os << get_value<details::ProgressBarOption::prefix_text>();
|
|
const auto result = os.str();
|
|
const auto result_size = unicode::display_width(result);
|
|
return {result, result_size};
|
|
}
|
|
|
|
std::pair<std::string, int> get_postfix_text() {
|
|
std::stringstream os;
|
|
const auto max_progress =
|
|
get_value<details::ProgressBarOption::max_progress>();
|
|
|
|
if (get_value<details::ProgressBarOption::show_percentage>()) {
|
|
os << " "
|
|
<< (std::min)(static_cast<size_t>(static_cast<float>(progress_) /
|
|
max_progress * 100),
|
|
size_t(100))
|
|
<< "%";
|
|
}
|
|
|
|
auto &saved_start_time =
|
|
get_value<details::ProgressBarOption::saved_start_time>();
|
|
|
|
if (get_value<details::ProgressBarOption::show_elapsed_time>()) {
|
|
os << " [";
|
|
if (saved_start_time)
|
|
details::write_duration(os, elapsed_);
|
|
else
|
|
os << "00:00s";
|
|
}
|
|
|
|
if (get_value<details::ProgressBarOption::show_remaining_time>()) {
|
|
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
|
os << "<";
|
|
else
|
|
os << " [";
|
|
|
|
if (saved_start_time) {
|
|
auto eta = std::chrono::nanoseconds(
|
|
progress_ > 0
|
|
? static_cast<long long>(std::ceil(float(elapsed_.count()) *
|
|
max_progress / progress_))
|
|
: 0);
|
|
auto remaining = eta > elapsed_ ? (eta - elapsed_) : (elapsed_ - eta);
|
|
details::write_duration(os, remaining);
|
|
} else {
|
|
os << "00:00s";
|
|
}
|
|
|
|
os << "]";
|
|
} else {
|
|
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
|
os << "]";
|
|
}
|
|
|
|
os << " " << get_value<details::ProgressBarOption::postfix_text>();
|
|
|
|
const auto result = os.str();
|
|
const auto result_size = unicode::display_width(result);
|
|
return {result, result_size};
|
|
}
|
|
|
|
public:
|
|
void print_progress(bool from_multi_progress = false) {
|
|
std::lock_guard<std::mutex> lock{mutex_};
|
|
|
|
auto &os = get_value<details::ProgressBarOption::stream>();
|
|
|
|
const auto type = get_value<details::ProgressBarOption::progress_type>();
|
|
const auto min_progress =
|
|
get_value<details::ProgressBarOption::min_progress>();
|
|
const auto max_progress =
|
|
get_value<details::ProgressBarOption::max_progress>();
|
|
if (multi_progress_mode_ && !from_multi_progress) {
|
|
if ((type == ProgressType::incremental && progress_ >= max_progress) ||
|
|
(type == ProgressType::decremental && progress_ <= min_progress)) {
|
|
get_value<details::ProgressBarOption::completed>() = true;
|
|
}
|
|
return;
|
|
}
|
|
auto now = std::chrono::high_resolution_clock::now();
|
|
if (!get_value<details::ProgressBarOption::completed>())
|
|
elapsed_ = std::chrono::duration_cast<std::chrono::nanoseconds>(
|
|
now - start_time_point_);
|
|
|
|
if (get_value<details::ProgressBarOption::foreground_color>() !=
|
|
Color::unspecified)
|
|
details::set_stream_color(
|
|
os, get_value<details::ProgressBarOption::foreground_color>());
|
|
|
|
for (auto &style : get_value<details::ProgressBarOption::font_styles>())
|
|
details::set_font_style(os, style);
|
|
|
|
const auto prefix_pair = get_prefix_text();
|
|
const auto prefix_text = prefix_pair.first;
|
|
const auto prefix_length = prefix_pair.second;
|
|
os << "\r" << prefix_text;
|
|
|
|
os << get_value<details::ProgressBarOption::start>();
|
|
|
|
details::ProgressScaleWriter writer{
|
|
os, get_value<details::ProgressBarOption::bar_width>(),
|
|
get_value<details::ProgressBarOption::fill>(),
|
|
get_value<details::ProgressBarOption::lead>(),
|
|
get_value<details::ProgressBarOption::remainder>()};
|
|
writer.write(double(progress_) / double(max_progress) * 100.0f);
|
|
|
|
os << get_value<details::ProgressBarOption::end>();
|
|
|
|
const auto postfix_pair = get_postfix_text();
|
|
const auto postfix_text = postfix_pair.first;
|
|
const auto postfix_length = postfix_pair.second;
|
|
os << postfix_text;
|
|
|
|
// Get length of prefix text and postfix text
|
|
const auto start_length = get_value<details::ProgressBarOption::start>().size();
|
|
const auto bar_width = get_value<details::ProgressBarOption::bar_width>();
|
|
const auto end_length = get_value<details::ProgressBarOption::end>().size();
|
|
const auto terminal_width = terminal_size().second;
|
|
// prefix + bar_width + postfix should be <= terminal_width
|
|
const int remaining = terminal_width - (prefix_length + start_length + bar_width + end_length + postfix_length);
|
|
if (prefix_length == -1 || postfix_length == -1) {
|
|
os << "\r";
|
|
} else if (remaining > 0) {
|
|
os << std::string(remaining, ' ') << "\r";
|
|
} else if (remaining < 0) {
|
|
// Do nothing. Maybe in the future truncate postfix with ...
|
|
}
|
|
os.flush();
|
|
|
|
if ((type == ProgressType::incremental && progress_ >= max_progress) ||
|
|
(type == ProgressType::decremental && progress_ <= min_progress)) {
|
|
get_value<details::ProgressBarOption::completed>() = true;
|
|
}
|
|
if (get_value<details::ProgressBarOption::completed>() &&
|
|
!from_multi_progress) // Don't std::endl if calling from MultiProgress
|
|
os << termcolor::reset << std::endl;
|
|
}
|
|
};
|
|
|
|
} // namespace indicators
|
|
|
|
#endif |