update

Author: karasikov

progress_bar.cpp

@@ -1,104 +1,115 @@
 #include "progress_bar.hpp"
 
-ProgressBar::ProgressBar() {}
+#include <iomanip>
 
-ProgressBar::ProgressBar(unsigned long n_, const char* description_, std::ostream& out_){
-    
-    n = n_;
-    frequency_update = n_;
-    description = description_;
+const size_t kMessageSize = 25;
+const double kTotalPercentage = 100.0;
+const size_t kCharacterWidthPercentage = 4;
+
+
+ProgressBar::ProgressBar(uint64_t total,
+                         const std::string &description,
+                         std::ostream &out_)
+      : total_(total), description_(description) {
+    frequency_update = std::min(static_cast<uint64_t>(1000), total_);
     out = &out_;
-	
-	unit_bar = "=";
-	unit_space = " ";
-	desc_width = std::strlen(description);	// character width of description field
+    *out << "\n";
 
+    assert(description_.size() <= kMessageSize);
+    description_.resize(kMessageSize, ' ');
 }
 
-void ProgressBar::SetFrequencyUpdate(unsigned long frequency_update_){
-	
-	if(frequency_update_ > n){
-		frequency_update = n;	 // prevents crash if freq_updates_ > n_
-	}
-	else{
-		frequency_update = frequency_update_;
-	}
+ProgressBar::~ProgressBar() {
+    *out << "\n";
 }
 
-void ProgressBar::SetStyle(const char* unit_bar_, const char* unit_space_){
-	
-	unit_bar = unit_bar_;
-	unit_space = unit_space_;
+void ProgressBar::SetFrequencyUpdate(uint64_t frequency_update_) {
+    if(frequency_update_ > total_){
+        frequency_update = total_;    // prevents crash if freq_updates_ > total_
+    } else{
+        frequency_update = frequency_update_;
+    }
 }
 
-int ProgressBar::GetConsoleWidth(){
+void ProgressBar::SetStyle(char unit_bar, char unit_space){
+    unit_bar_ = unit_bar;
+    unit_space_ = unit_space;
+}
 
+int ProgressBar::GetConsoleWidth() {
     int width;
 
-	#ifdef _WINDOWS
-		CONSOLE_SCREEN_BUFFER_INFO csbi;
-		GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
-		width = csbi.srWindow.Right - csbi.srWindow.Left;
-	#else
-		struct winsize win;
-		ioctl(0, TIOCGWINSZ, &win);
+    #ifdef _WINDOWS
+        CONSOLE_SCREEN_BUFFER_INFO csbi;
+        GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
+        width = csbi.srWindow.Right - csbi.srWindow.Left;
+    #else
+        struct winsize win;
+        ioctl(0, TIOCGWINSZ, &win);
         width = win.ws_col;
-	#endif
+    #endif
 
     return width;
 }
 
-int ProgressBar::GetBarLength(){
-
-	// get console width and according adjust the length of the progress bar
-
-    int bar_length = static_cast<int>((GetConsoleWidth() - desc_width - CHARACTER_WIDTH_PERCENTAGE) / 2.);
-
-	return bar_length;
+int ProgressBar::GetBarLength() {
+    // get console width and according adjust the length of the progress bar
+    return (GetConsoleWidth() - description_.size()
+                                - kCharacterWidthPercentage) / 2.;
 }
 
-void ProgressBar::ClearBarField(){
-
-    for(int i=0;i<GetConsoleWidth();++i){
+void ProgressBar::ClearBarField() {
+    for(int i = 0; i < GetConsoleWidth(); ++i) {
         *out << " ";
     }
     *out << "\r" << std::flush;
 }
 
-void ProgressBar::Progressed(unsigned long idx_)
-{
-    try{
-        if(idx_ > n) throw idx_;
+void ProgressBar::Progressed(uint64_t idx_) {
+    try {
+        if (idx_ > total_)
+            throw idx_;
+
+        progress_ = idx_;
 
         // determines whether to update the progress bar from frequency_update
-	    if ((idx_ != n) && (idx_ % (n/frequency_update) != 0)) return;
+        if ((idx_ != total_) && (idx_ % (total_ / frequency_update) != 0))
+            return;
 
         // calculate the size of the progress bar
-	    int bar_size = GetBarLength();
-    
+        int bar_size = GetBarLength();
+
         // calculate percentage of progress
-        double progress_percent = idx_* TOTAL_PERCENTAGE/n;
+        double progress_percent = idx_* kTotalPercentage / total_;
 
-        // calculate the percentage value of a unit bar 
-        double percent_per_unit_bar = TOTAL_PERCENTAGE/bar_size;
+        // calculate the percentage value of a unit bar
+        double percent_per_unit_bar = kTotalPercentage / bar_size;
 
         // display progress bar
-	    *out << " " << description << " [";
-
-        for(int bar_length=0;bar_length<=bar_size-1;++bar_length){
-            if(bar_length*percent_per_unit_bar<progress_percent){
-                *out << unit_bar;
-            }
-            else{
-                *out << unit_space;
-            }
+        // *out << " " << (percent_per_unit_bar < 1
+        //                 ? description
+        //                 : std::string(' ', desc_width)) << " [";
+        *out << " " << description_ << " [";
+
+        for(int bar_length = 0; bar_length <= bar_size - 1; ++bar_length) {
+            *out << (bar_length * percent_per_unit_bar < progress_percent
+                    ? unit_bar_
+                    : unit_space_);
         }
 
-        *out << "]" << std::setw(CHARACTER_WIDTH_PERCENTAGE + 1) << std::setprecision(1) << std::fixed << progress_percent << "%\r" << std::flush;
-    }
-    catch(unsigned long e){
+        *out << "]" << std::setw(kCharacterWidthPercentage + 1)
+                    << std::setprecision(1)
+                    << std::fixed
+                    << progress_percent << "%\r" << std::flush;
+    } catch (uint64_t e) {
         ClearBarField();
-        std::cerr << "PROGRESS_BAR_EXCEPTION: _idx (" << e << ") went out of bounds, greater than n (" << n << ")." << std::endl << std::flush;
+        std::cerr << "PROGRESS_BAR_EXCEPTION: _idx ("
+                  << e << ") went out of bounds, greater than total_ ("
+                  << total_ << ")." << std::endl << std::flush;
     }
+}
 
+ProgressBar& ProgressBar::operator++() {
+    this->Progressed(progress_ + 1);
+    return *this;
 }

progress_bar.hpp

@@ -8,39 +8,35 @@
 #endif
 
 #include <iostream>
-#include <iomanip>
-#include <cstring>
+#include <string>
 
-#define TOTAL_PERCENTAGE 100.0
-#define CHARACTER_WIDTH_PERCENTAGE 4
 
 class ProgressBar{
+  public:
+    ProgressBar(uint64_t total,
+                const std::string &description = "",
+                std::ostream &out = std::cerr);
+    ~ProgressBar();
 
-public: 
+    void SetFrequencyUpdate(uint64_t frequency_update_);
+    void SetStyle(char unit_bar, char unit_space);
 
-    ProgressBar();
-    ProgressBar(unsigned long n_, const char *description_="", std::ostream& out_=std::cerr);
+    void Progressed(uint64_t idx_);
+    ProgressBar& operator++();
 
-    void SetFrequencyUpdate(unsigned long frequency_update_);
-    void SetStyle(const char* unit_bar_, const char* unit_space_);		
+  private:
+    uint64_t total_;
+    uint64_t progress_ = 0;
+    uint64_t frequency_update;
+    std::ostream *out;
 
-    void Progressed(unsigned long idx_);
+    std::string description_;
+    char unit_bar_ = '=';
+    char unit_space_ = ' ';
 
-private:
-	
-    unsigned long n;
-    unsigned int desc_width;
-    unsigned long frequency_update;
-    std::ostream* out;
-		
-    const char *description;
-    const char *unit_bar;
-    const char *unit_space;
-		
     void ClearBarField();
     int GetConsoleWidth();
     int GetBarLength();
-
 };
 
 #endif