Merge pull request #21 from dawidpilarski/dev

API change - progress bar can be constructed with proper settings.
2025-12-16 04:18:51 +08:00 · 2020-02-11 13:38:14 +05:30
parent e279bbb7e7 5c54b69e55
commit 764d796f87
14 changed files with 841 additions and 553 deletions
--- a/samples/block_progress_bar.cpp
+++ b/samples/block_progress_bar.cpp
@@ -7,13 +7,9 @@ int main() {
  // Hide cursor
  std::cout << "\e[?25l";

-  indicators::BlockProgressBar bar;
-
-  // Configure the bar
-  bar.set_bar_width(80);
-  bar.start_bar_with("[");
-  bar.end_bar_with("]");
-  bar.set_foreground_color(indicators::Color::WHITE);
+  indicators::BlockProgressBar bar{
+    indicators::option::BarWidth {80}
+  };

  // Update bar state
  auto progress = 0.0f;
--- a/samples/multi_block_progress_bar.cpp
+++ b/samples/multi_block_progress_bar.cpp
@@ -2,27 +2,30 @@
 #include <indicators/multi_progress.hpp>

 int main() {
+  using namespace indicators;
+  BlockProgressBar bar1{
+    option::BarWidth{50},
+    option::ForegroundColor{Color::YELLOW},
+    option::ShowElapsedTime{true},
+    option::ShowRemainingTime{true},
+    option::PrefixText{"Progress Bar #1 "}
+  };

-  indicators::BlockProgressBar bar1;
-  bar1.set_bar_width(50);
-  bar1.set_foreground_color(indicators::Color::YELLOW);
-  bar1.show_elapsed_time();
-  bar1.show_remaining_time();
-  bar1.set_prefix_text("Progress Bar #1 ");
+  BlockProgressBar bar2{
+    option::BarWidth{50},
+    option::ForegroundColor{Color::CYAN},
+    option::ShowElapsedTime{true},
+    option::ShowRemainingTime{true},
+    option::PrefixText{"Progress Bar #2 "}
+  };

-  indicators::BlockProgressBar bar2;
-  bar2.set_bar_width(50);
-  bar2.set_foreground_color(indicators::Color::CYAN);
-  bar2.show_elapsed_time();
-  bar2.show_remaining_time();
-  bar2.set_prefix_text("Progress Bar #2 ");
-
-  indicators::BlockProgressBar bar3;
-  bar3.set_bar_width(50);
-  bar3.set_foreground_color(indicators::Color::RED);
-  bar3.show_elapsed_time();
-  bar3.show_remaining_time();
-  bar3.set_prefix_text("Progress Bar #3 ");
+  BlockProgressBar bar3{
+    option::BarWidth{50},
+    option::ForegroundColor{Color::RED},
+    option::ShowElapsedTime{true},
+    option::ShowRemainingTime{true},
+    option::PrefixText{"Progress Bar #3 "}
+  };

  indicators::MultiProgress<indicators::BlockProgressBar, 3> bars(bar1, bar2, bar3);

--- a/samples/multi_progress_bar.cpp
+++ b/samples/multi_progress_bar.cpp
@@ -3,41 +3,44 @@

 int main() {

-  indicators::ProgressBar bar1;
-  bar1.set_bar_width(50);
-  bar1.start_bar_with("[");
-  bar1.fill_bar_progress_with("■");
-  bar1.lead_bar_progress_with("■");
-  bar1.fill_bar_remainder_with(" ");
-  bar1.end_bar_with(" ]");
-  bar1.set_foreground_color(indicators::Color::YELLOW);
-  bar1.show_elapsed_time();
-  bar1.show_remaining_time();
-  bar1.set_prefix_text("Progress Bar #1 ");
+  indicators::ProgressBar bar1{
+    indicators::option::BarWidth{50},
+    indicators::option::Start{"["},
+    indicators::option::Fill{"■"},
+    indicators::option::Lead{"■"},
+    indicators::option::Remainder{" "},
+    indicators::option::End{" ]"},
+    indicators::option::ForegroundColor{indicators::Color::YELLOW},
+    indicators::option::ShowElapsedTime{true},
+    indicators::option::ShowRemainingTime{true},
+    indicators::option::PrefixText{"Progress Bar #1 "}
+  };

-  indicators::ProgressBar bar2;
-  bar2.set_bar_width(50);
-  bar2.start_bar_with("[");
-  bar2.fill_bar_progress_with("=");
-  bar2.lead_bar_progress_with(">");
-  bar2.fill_bar_remainder_with(" ");
-  bar2.end_bar_with(" ]");
-  bar2.set_foreground_color(indicators::Color::CYAN);
-  bar2.show_elapsed_time();
-  bar2.show_remaining_time();
-  bar2.set_prefix_text("Progress Bar #2 ");
+  indicators::ProgressBar bar2{
+    indicators::option::BarWidth{50},
+    indicators::option::Start{"["},
+    indicators::option::Fill{"="},
+    indicators::option::Lead{">"},
+    indicators::option::Remainder{" "},
+    indicators::option::End{" ]"},
+    indicators::option::ForegroundColor{indicators::Color::CYAN},
+    indicators::option::ShowElapsedTime{true},
+    indicators::option::ShowRemainingTime{true},
+    indicators::option::PrefixText{"Progress Bar #2 "}
+  };

-  indicators::ProgressBar bar3;
-  bar3.set_bar_width(50);
-  bar3.start_bar_with("[");
-  bar3.fill_bar_progress_with("#");
-  bar3.lead_bar_progress_with("#");
-  bar3.fill_bar_remainder_with(" ");
-  bar3.end_bar_with(" ]");
-  bar3.set_foreground_color(indicators::Color::RED);
-  bar3.show_elapsed_time();
-  bar3.show_remaining_time();
-  bar3.set_prefix_text("Progress Bar #3 ");
+  indicators::ProgressBar bar3{
+    indicators::option::BarWidth{50},
+    indicators::option::Start{"["},
+    indicators::option::Fill{"#"},
+    indicators::option::Lead{"#"},
+    indicators::option::Remainder{" "},
+    indicators::option::End{" ]"},
+    indicators::option::ForegroundColor{indicators::Color::CYAN},
+    indicators::option::ShowElapsedTime{true},
+    indicators::option::ShowRemainingTime{true},
+    indicators::option::PrefixText{"Progress Bar #3 "}
+  };

  indicators::MultiProgress<indicators::ProgressBar, 3> bars(bar1, bar2, bar3);

--- a/samples/multi_threaded_bar.cpp
+++ b/samples/multi_threaded_bar.cpp
@@ -3,14 +3,15 @@

 int main() {

-  indicators::ProgressBar bar;
-  bar.set_bar_width(50);
-  bar.start_bar_with("[");
-  bar.fill_bar_progress_with("■");
-  bar.lead_bar_progress_with("■");
-  bar.fill_bar_remainder_with("-");
-  bar.end_bar_with("]");
-  bar.set_foreground_color(indicators::Color::YELLOW);
+  indicators::ProgressBar bar{
+    indicators::option::BarWidth{50},
+    indicators::option::Start{"["},
+    indicators::option::Fill{"■"},
+    indicators::option::Lead{"■"},
+    indicators::option::Remainder{"-"},
+    indicators::option::End{" ]"},
+    indicators::option::ForegroundColor{indicators::Color::YELLOW},
+  };

  // As configured, the bar will look like this:
  //
@@ -39,7 +40,7 @@ int main() {
      if (bar.is_completed()) {
        break;
      }
-      bar.set_postfix_text(status_text[index % status_text.size()]);
+      bar.set_option(indicators::option::PostfixText{status_text[index % status_text.size()]});
      bar.tick();
      index += 1;
      std::this_thread::sleep_for(std::chrono::milliseconds(200));
--- a/samples/progress_bar_set_progress.cpp
+++ b/samples/progress_bar_set_progress.cpp
@@ -7,17 +7,16 @@ int main() {
  // Hide cursor
  std::cout << "\e[?25l";

-  indicators::ProgressBar bar;
-
-  // Configure the bar
-  bar.set_bar_width(50);
-  bar.start_bar_with("[");
-  bar.fill_bar_progress_with("■");
-  bar.lead_bar_progress_with("■");
-  bar.fill_bar_remainder_with("-");
-  bar.end_bar_with(" ]");
-  bar.set_postfix_text("Loading dependency 1/4");
-  bar.set_foreground_color(indicators::Color::CYAN);
+  indicators::ProgressBar bar{
+    indicators::option::BarWidth{50},
+    indicators::option::Start{"["},
+    indicators::option::Fill{"■"},
+    indicators::option::Lead{"■"},
+    indicators::option::Remainder{"-"},
+    indicators::option::End{" ]"},
+    indicators::option::PostfixText{"Loading dependency 1/4"},
+    indicators::option::ForegroundColor{indicators::Color::CYAN},
+  };

  // Update bar state
  bar.set_progress(10); // 10% done
@@ -25,21 +24,21 @@ int main() {
  // do some work
  std::this_thread::sleep_for(std::chrono::milliseconds(800));

-  bar.set_postfix_text("Loading dependency 2/4");
+  bar.set_option(indicators::option::PostfixText{"Loading dependency 2/4"});

  bar.set_progress(30); // 30% done

  // do some more work
  std::this_thread::sleep_for(std::chrono::milliseconds(700));

-  bar.set_postfix_text("Loading dependency 3/4");
+  bar.set_option(indicators::option::PostfixText{"Loading dependency 3/4"});

  bar.set_progress(65); // 65% done

  // do final bit of work
  std::this_thread::sleep_for(std::chrono::milliseconds(900));

-  bar.set_postfix_text("Loaded dependencies!");
+  bar.set_option(indicators::option::PostfixText{"Loaded dependencies!"});

  bar.set_progress(100); // all done

--- a/samples/progress_bar_tick.cpp
+++ b/samples/progress_bar_tick.cpp
@@ -3,17 +3,16 @@
 #include <thread>

 int main() {
-  indicators::ProgressBar bar;
-
-  // Configure the bar
-  bar.set_bar_width(50);
-  bar.start_bar_with("[");
-  bar.fill_bar_progress_with("=");
-  bar.lead_bar_progress_with(">");
-  bar.fill_bar_remainder_with(" ");
-  bar.end_bar_with("]");
-  bar.set_postfix_text("Getting started");
-  bar.set_foreground_color(indicators::Color::GREEN);
+  indicators::ProgressBar bar{
+    indicators::option::BarWidth{50},
+    indicators::option::Start{"["},
+    indicators::option::Fill{"="},
+    indicators::option::Lead{">"},
+    indicators::option::Remainder{" "},
+    indicators::option::End{" ]"},
+    indicators::option::PostfixText{"Getting started"},
+    indicators::option::ForegroundColor{indicators::Color::GREEN},
+  };

  // Update bar state
  while (true) {
--- a/samples/progress_spinner.cpp
+++ b/samples/progress_spinner.cpp
@@ -5,22 +5,21 @@ int main() {
  // Hide cursor
  std::cout << "\e[?25l";

-  indicators::ProgressSpinner spinner;
-
-  // Configure the spinner
-  spinner.set_postfix_text("Checking credentials");
-  spinner.set_foreground_color(indicators::Color::YELLOW);
-  spinner.set_spinner_states({"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"});
+  indicators::ProgressSpinner spinner{
+    indicators::option::PostfixText{"Checking credentials"},
+    indicators::option::ForegroundColor{indicators::Color::YELLOW},
+    indicators::option::SpinnerStates{std::vector<std::string>{"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"}},
+  };

  // Update spinner state
  auto job = [&spinner]() {
    while (true) {
      if (spinner.is_completed()) {
-        spinner.set_foreground_color(indicators::Color::GREEN);
-        spinner.set_prefix_text("✔");
-        spinner.hide_spinner();
-        spinner.hide_percentage();
-        spinner.set_postfix_text("Authenticated!");
+        spinner.set_option(indicators::option::ForegroundColor{indicators::Color::GREEN});
+        spinner.set_option(indicators::option::PrefixText{"✔"});
+        spinner.set_option(indicators::option::ShowSpinner{false});
+        spinner.set_option(indicators::option::ShowPercentage{false});
+        spinner.set_option(indicators::option::PostfixText{"Authenticated!"});
        spinner.mark_as_completed();
        break;
      } else
--- a/samples/time_meter.cpp
+++ b/samples/time_meter.cpp
@@ -3,21 +3,18 @@
 #include <thread>

 int main() {
-  indicators::ProgressBar bar;
-
-  // Configure the bar
-  bar.set_bar_width(50);
-  bar.start_bar_with(" [");
-  bar.fill_bar_progress_with("█");
-  bar.lead_bar_progress_with("█");
-  bar.fill_bar_remainder_with("-");
-  bar.end_bar_with("]");
-  bar.set_prefix_text("Training Gaze Network 👀");
-  bar.set_foreground_color(indicators::Color::YELLOW);
-
-  // Show time elapsed and remaining
-  bar.show_elapsed_time();
-  bar.show_remaining_time();
+  indicators::ProgressBar bar{
+    indicators::option::BarWidth{50},
+    indicators::option::Start{" ["},
+    indicators::option::Fill{"█"},
+    indicators::option::Lead{"█"},
+    indicators::option::Remainder{"-"},
+    indicators::option::End{"]"},
+    indicators::option::PostfixText{"Training Gaze Network "},
+    indicators::option::ForegroundColor{indicators::Color::YELLOW},
+    indicators::option::ShowElapsedTime{true},
+    indicators::option::ShowRemainingTime{true},
+  };

  // Update bar state
  while (true) {