libs/EDoc/ProgressBar.cpp

Go to the documentation of this file.

/*******************************************************************************

   Copyright (C) 2007 by Brendon Costa

   This library is free software; you can redistribute it and/or modify 
   it under the terms of the "LGPL Like" License defined in the file COPYING 
   that should have been distributed along with this source.

   This library is distributed in the hope that it will be useful, 
   but WITHOUT ANY WARRANTY; without even the implied warranty of 
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

   You should have received a copy of the "LGPL Like" License 
   along with this library; see the file COPYING. if not, it can be 
   obtained from the EDoc++ website: 
   http://edoc.sourceforge.net/license.html

*******************************************************************************/
#include "config.h"

#include "EDoc/ProgressBar.h"
#include "EDoc/utils.h"

#include <iostream>

namespace EDoc
{
   //===========================================================================
   const char* ProgressBar::DEFAULT_SPIN_SEQUENCE = "|/-\\";
   //===========================================================================
   ProgressBar::ProgressBar(bool enable_spinner_in, int width_in, 
         std::string spin_sequence_in) :

      enable_spinner(enable_spinner_in),
      width(width_in),
      spin_sequence(spin_sequence_in)
   {
      Reset();
   }
   //===========================================================================
   void ProgressBar::Reset()
   {
      bars = 0;
      spin_index = 0;
   }
   //===========================================================================
   void ProgressBar::Start(size_t total_in)
   {
      current = 0;
      total = total_in;
   }
   //===========================================================================
   void ProgressBar::Progress(Function* EDOC_UNUSED(data))
   {
      size_t count = ++current;
      int b = width * count / total;
      if (b > bars)
      {
         // If the spinner has been displayed then delete it.
         if (enable_spinner && spin_index >= 0)
         {
            std::cerr << "\b";
         }

         // Display the next few bars.
         for (int i = 0; i < (b - bars); i++)
         {
            std::cerr << '=';
         }

         bars = b;

         // After displaying the final bar exit without the spinner.
         if (b == width)
         {
            std::cerr << std::endl;
            return;
         }

         if (enable_spinner)
         {
            // Write a temp char that is to be overwritten by the spinner.
            std::cerr << "?";
         }
      }

      if (enable_spinner)
      {
         // Display the spinner if we have not reached 100%
         spin_index = (spin_index + 1) % spin_sequence.size();
         std::cerr << "\b" << spin_sequence[spin_index] << std::flush;
      }
   }
   //===========================================================================

}

---