include/EDoc/ProgressBar.h

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

*******************************************************************************/
#ifndef EDOC_PROGRESSBAR_H
#define EDOC_PROGRESSBAR_H

#include "EDoc/ProgressIFace.h"
#include <string>

namespace EDoc
{
   //===========================================================================
   /** \brief Displays a percentage progress bar as a bar of '=' characters
    * across the screen.
    *
    * This has two configurations:
    *    -# Interactive
    *    -# Non Interactive
    *    .
    *
    * The interactive varient will display a "spinner" in addition to the '='
    * characters that updates regulary. This requires a terminal as otherwise
    * of exporting output to a file it will contain a number of back-space
    * characters.
    */
   class ProgressBar : public FunctionProgressIFace
   {
   public:

      //------------------------------------------------------------------------
      /** \brief This is the default spin sequence for the spinner.
       *
       * It is a sequence of characters to display when the progress indication
       * increases.
       */
      static const char* DEFAULT_SPIN_SEQUENCE;

      //------------------------------------------------------------------------
      /** \brief This is the default screen width to use.
       *
       * \todo Find a way of getting the current terminal width so we do not
       * make assumptions.
       */
      static const int DEFAULT_SCREEN_WIDTH = 80;



      //------------------------------------------------------------------------
      /** \brief Create a new progress bar instance.
       *
       * \param enable_spinner_in When in iteractive mode this is enabled and
       * displays a spinner when any progress is made.
       *
       * \param width_in The width to assume the terminal width is.
       *
       * \param spin_sequence_in The spin sequence to use if enable_spinner_in
       * is true.
       */
      ProgressBar(bool enable_spinner_in = false,
            int width_in = DEFAULT_SCREEN_WIDTH, 
            std::string spin_sequence_in = DEFAULT_SPIN_SEQUENCE);

      //------------------------------------------------------------------------
      /** \brief Resets the progress bar to start displaying progress again from
       * 0.
       */
      void Reset();

      //------------------------------------------------------------------------
      /** \brief See FunctionProgressIFace::Start()
       */
      virtual void Start(size_t total);

      //------------------------------------------------------------------------
      /** \brief See FunctionProgressIFace::Progress()
       */
      virtual void Progress(Function* data);

      //------------------------------------------------------------------------

   private:

      //------------------------------------------------------------------------
      /** \brief True if spinner is enabled.
       */
      bool enable_spinner;

      //------------------------------------------------------------------------
      /** \brief The width of the terminal to assume.
       */
      int width;

      //------------------------------------------------------------------------
      /** \brief The equence of characters to display when incrementing the
       * progres for a spinner.
       */
      std::string spin_sequence;

      //------------------------------------------------------------------------
      /** \brief Current number of bars being displayed.
       */
      int bars;

      //------------------------------------------------------------------------
      /** \brief Current index for the spinner. This determines which character
       * to display next from the spin_sequence.
       */
      int spin_index;

      size_t total;
      size_t current;
      //------------------------------------------------------------------------
   };
   //===========================================================================

}

#endif // EDOC_PROGRESSBAR_H

---