Skip to content

Feature/countdown progress bar #59

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

Merged
p-ranav merged 4 commits into from
May 25, 2020
Merged

Feature/countdown progress bar #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
120f922
Added progress_type option to indicate incremental/decremental progress
p-ranav May 25, 2020
4dff4e7
Restored decremental progress demo
p-ranav May 25, 2020
d056243
Added ProgressType enum and updated single include
p-ranav May 25, 2020
885748d
Reverted minor changes to stream helper w.r.t checking if fill, lead …
p-ranav May 25, 2020
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
34 changes: 32 additions & 2 deletions demo/demo.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ int main() {
// PROGRESS BAR 2
//
indicators::ProgressBar p;
p.set_option(option::BarWidth{40});
p.set_option(option::BarWidth{0});
p.set_option(option::PrefixText{"Reading package list... "});
p.set_option(option::Start{""});
p.set_option(option::Fill{""});
Expand Down Expand Up @@ -141,6 +141,7 @@ int main() {
std::cout << std::endl;
p4.set_option(option::ForegroundColor{indicators::Color::red});
p4.set_option(option::PrefixText{"{ ERROR }"});
p4.set_option(option::BarWidth{0});
p4.set_option(option::Start{});
p4.set_option(option::Fill{});
p4.set_option(option::Lead{});
Expand All @@ -158,6 +159,35 @@ int main() {
thread4.join();

std::this_thread::sleep_for(std::chrono::milliseconds(100));

{
//
// GOING BACKWARDS
//
indicators::ProgressBar p{option::BarWidth{50},
option::ProgressType{ProgressType::decremental},
option::Start{"["},
option::Fill{"■"},
option::Lead{"■"},
option::Remainder{"-"},
option::End{"]"},
option::ForegroundColor{indicators::Color::white},
option::PostfixText{"Reverting system restore"},
option::FontStyles{
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
auto job = [&p]() {
while (true) {
p.tick();
if (p.is_completed()) {
p.set_option(option::PostfixText{"Revert complete!"});
break;
}
std::this_thread::sleep_for(std::chrono::milliseconds(60));
}
};
std::thread thread(job);
thread.join();
}
}

{
Expand Down Expand Up @@ -285,4 +315,4 @@ int main() {
show_console_cursor(true);

return 0;
}
}
2 changes: 1 addition & 1 deletion include/indicators/details/stream_helper.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,4 +215,4 @@ class IndeterminateProgressScaleWriter {
};

} // namespace details
} // namespace indicators
} // namespace indicators
38 changes: 31 additions & 7 deletions include/indicators/progress_bar.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ class ProgressBar {
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::MaxProgress, option::Stream>;
option::ForegroundColor, option::FontStyles,
option::MinProgress, option::MaxProgress,
option::ProgressType,
option::Stream>;

public:
template <typename... Args,
Expand Down Expand Up @@ -64,10 +67,23 @@ class ProgressBar {
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)...)) {}
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) {
Expand Down Expand Up @@ -119,7 +135,11 @@ class ProgressBar {
void tick() {
{
std::lock_guard<std::mutex> lock{mutex_};
progress_ += 1;
const auto type = get_value<details::ProgressBarOption::progress_type>();
if (type == ProgressType::incremental)
progress_ += 1;
else
progress_ -= 1;
}
save_start_time();
print_progress();
Expand Down Expand Up @@ -175,9 +195,12 @@ class ProgressBar {

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 (progress_ >= max_progress) {
if ((type == ProgressType::incremental && progress_ >= max_progress) ||
(type == ProgressType::decremental && progress_ <= min_progress)) {
get_value<details::ProgressBarOption::completed>() = true;
}
return;
Expand Down Expand Up @@ -246,9 +269,10 @@ class ProgressBar {
<< std::string(get_value<details::ProgressBarOption::max_postfix_text_len>(), ' ')
<< "\r";
os.flush();
if (progress_ >= max_progress) {
get_value<details::ProgressBarOption::completed>() = true;
}
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;
Expand Down
5 changes: 5 additions & 0 deletions include/indicators/progress_type.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#pragma once

namespace indicators {
enum class ProgressType { incremental, decremental };
}
5 changes: 5 additions & 0 deletions include/indicators/setting.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ SOFTWARE.
#include <cstddef>
#include <indicators/color.hpp>
#include <indicators/font_style.hpp>
#include <indicators/progress_type.hpp>
#include <string>
#include <tuple>
#include <type_traits>
Expand Down Expand Up @@ -91,7 +92,9 @@ enum class ProgressBarOption {
spinner_states,
font_styles,
hide_bar_when_complete,
min_progress,
max_progress,
progress_type,
stream
};

Expand Down Expand Up @@ -207,7 +210,9 @@ using HideBarWhenComplete =
details::BooleanSetting<details::ProgressBarOption::hide_bar_when_complete>;
using FontStyles =
details::Setting<std::vector<FontStyle>, details::ProgressBarOption::font_styles>;
using MinProgress = details::IntegerSetting<details::ProgressBarOption::min_progress>;
using MaxProgress = details::IntegerSetting<details::ProgressBarOption::max_progress>;
using ProgressType = details::Setting<ProgressType, details::ProgressBarOption::progress_type>;
using Stream = details::Setting<std::ostream&, details::ProgressBarOption::stream>;
} // namespace option
} // namespace indicators
1 change: 1 addition & 0 deletions single_include.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"sources": [
"include/indicators/color.hpp",
"include/indicators/font_style.hpp",
"include/indicators/progress_type.hpp",
"include/indicators/termcolor.hpp",
"include/indicators/terminal_size.hpp",
"include/indicators/setting.hpp",
Expand Down
63 changes: 50 additions & 13 deletions single_include/indicators/indicators.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,11 @@ namespace indicators {

enum class FontStyle { bold, dark, italic, underline, blink, reverse, concealed, crossed };

}
#pragma once

namespace indicators {
enum class ProgressType { incremental, decremental };
}
//!
//! termcolor
Expand Down Expand Up @@ -978,6 +983,7 @@ SOFTWARE.
#include <cstddef>
// #include <indicators/color.hpp>
// #include <indicators/font_style.hpp>
// #include <indicators/progress_type.hpp>
#include <string>
#include <tuple>
#include <type_traits>
Expand Down Expand Up @@ -1040,7 +1046,9 @@ enum class ProgressBarOption {
spinner_states,
font_styles,
hide_bar_when_complete,
min_progress,
max_progress,
progress_type,
stream
};

Expand Down Expand Up @@ -1156,7 +1164,9 @@ using HideBarWhenComplete =
details::BooleanSetting<details::ProgressBarOption::hide_bar_when_complete>;
using FontStyles =
details::Setting<std::vector<FontStyle>, details::ProgressBarOption::font_styles>;
using MinProgress = details::IntegerSetting<details::ProgressBarOption::min_progress>;
using MaxProgress = details::IntegerSetting<details::ProgressBarOption::max_progress>;
using ProgressType = details::Setting<ProgressType, details::ProgressBarOption::progress_type>;
using Stream = details::Setting<std::ostream&, details::ProgressBarOption::stream>;
} // namespace option
} // namespace indicators
Expand Down Expand Up @@ -1719,18 +1729,21 @@ class ProgressScaleWriter {

std::ostream &write(float progress) {
auto pos = static_cast<size_t>(progress * bar_width / 100.0);
for (size_t i = 0, current_display_width = 0; i < bar_width;) {
std::string next;
for (size_t i = 0; i < bar_width;) {
std::string next{""};
size_t current_display_width = 0;

if (i < pos) {
if (i < pos && !fill.empty()) {
next = fill;
current_display_width = unicode::display_width(fill);
} else if (i == pos) {
} else if (i == pos && !lead.empty()) {
next = lead;
current_display_width = unicode::display_width(lead);
} else {
next = remainder;
current_display_width = unicode::display_width(remainder);
if (!remainder.empty()) {
next = remainder;
current_display_width = unicode::display_width(remainder);
}
}

i += current_display_width;
Expand Down Expand Up @@ -1825,7 +1838,10 @@ class ProgressBar {
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::MaxProgress, option::Stream>;
option::ForegroundColor, option::FontStyles,
option::MinProgress, option::MaxProgress,
option::ProgressType,
option::Stream>;

public:
template <typename... Args,
Expand Down Expand Up @@ -1865,10 +1881,23 @@ class ProgressBar {
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)...)) {}
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) {
Expand Down Expand Up @@ -1920,7 +1949,11 @@ class ProgressBar {
void tick() {
{
std::lock_guard<std::mutex> lock{mutex_};
progress_ += 1;
const auto type = get_value<details::ProgressBarOption::progress_type>();
if (type == ProgressType::incremental)
progress_ += 1;
else
progress_ -= 1;
}
save_start_time();
print_progress();
Expand Down Expand Up @@ -1976,9 +2009,12 @@ class ProgressBar {

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 (progress_ >= max_progress) {
if ((type == ProgressType::incremental && progress_ >= max_progress) ||
(type == ProgressType::decremental && progress_ <= min_progress)) {
get_value<details::ProgressBarOption::completed>() = true;
}
return;
Expand Down Expand Up @@ -2047,9 +2083,10 @@ class ProgressBar {
<< std::string(get_value<details::ProgressBarOption::max_postfix_text_len>(), ' ')
<< "\r";
os.flush();
if (progress_ >= max_progress) {
get_value<details::ProgressBarOption::completed>() = true;
}
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;
Expand Down