sl@0: //  boost progress.hpp header file  ------------------------------------------//
sl@0: 
sl@0: //  Copyright Beman Dawes 1994-99.  Distributed under the Boost
sl@0: //  Software License, Version 1.0. (See accompanying file
sl@0: //  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
sl@0: 
sl@0: //  See http://www.boost.org/libs/timer for documentation.
sl@0: 
sl@0: //  Revision History
sl@0: //   1 Dec 01  Add leading progress display strings (suggested by Toon Knapen)
sl@0: //  20 May 01  Introduce several static_casts<> to eliminate warning messages
sl@0: //             (Fixed by Beman, reported by Herve Bronnimann)
sl@0: //  12 Jan 01  Change to inline implementation to allow use without library
sl@0: //             builds. See docs for more rationale. (Beman Dawes) 
sl@0: //  22 Jul 99  Name changed to .hpp
sl@0: //  16 Jul 99  Second beta
sl@0: //   6 Jul 99  Initial boost version
sl@0: 
sl@0: #ifndef BOOST_PROGRESS_HPP
sl@0: #define BOOST_PROGRESS_HPP
sl@0: 
sl@0: #include <boost/timer.hpp>
sl@0: #include <boost/utility.hpp>  // for noncopyable
sl@0: #include <boost/cstdint.hpp>  // for uintmax_t
sl@0: #include <iostream>           // for ostream, cout, etc
sl@0: #include <string>             // for string
sl@0: 
sl@0: namespace boost {
sl@0: 
sl@0: //  progress_timer  ----------------------------------------------------------//
sl@0: 
sl@0: //  A progress_timer behaves like a timer except that the destructor displays
sl@0: //  an elapsed time message at an appropriate place in an appropriate form.
sl@0: 
sl@0: class progress_timer : public timer, private noncopyable
sl@0: {
sl@0:   
sl@0:  public:
sl@0:   explicit progress_timer( std::ostream & os = std::cout )
sl@0:      // os is hint; implementation may ignore, particularly in embedded systems
sl@0:      : m_os(os) {}
sl@0:   ~progress_timer()
sl@0:   {
sl@0:   //  A) Throwing an exception from a destructor is a Bad Thing.
sl@0:   //  B) The progress_timer destructor does output which may throw.
sl@0:   //  C) A progress_timer is usually not critical to the application.
sl@0:   //  Therefore, wrap the I/O in a try block, catch and ignore all exceptions.
sl@0:     try
sl@0:     {
sl@0:       // use istream instead of ios_base to workaround GNU problem (Greg Chicares)
sl@0:       std::istream::fmtflags old_flags = m_os.setf( std::istream::fixed,
sl@0:                                                    std::istream::floatfield );
sl@0:       std::streamsize old_prec = m_os.precision( 2 );
sl@0:       m_os << elapsed() << " s\n" // "s" is System International d'Unités std
sl@0:                         << std::endl;
sl@0:       m_os.flags( old_flags );
sl@0:       m_os.precision( old_prec );
sl@0:     }
sl@0: 
sl@0:     catch (...) {} // eat any exceptions
sl@0:   } // ~progress_timer
sl@0: 
sl@0:  private:
sl@0:   std::ostream & m_os;
sl@0: };
sl@0: 
sl@0: 
sl@0: //  progress_display  --------------------------------------------------------//
sl@0: 
sl@0: //  progress_display displays an appropriate indication of 
sl@0: //  progress at an appropriate place in an appropriate form.
sl@0: 
sl@0: // NOTE: (Jan 12, 2001) Tried to change unsigned long to boost::uintmax_t, but
sl@0: // found some compilers couldn't handle the required conversion to double.
sl@0: // Reverted to unsigned long until the compilers catch up. 
sl@0: 
sl@0: class progress_display : private noncopyable
sl@0: {
sl@0:  public:
sl@0:   explicit progress_display( unsigned long expected_count,
sl@0:                              std::ostream & os = std::cout,
sl@0:                              const std::string & s1 = "\n", //leading strings
sl@0:                              const std::string & s2 = "",
sl@0:                              const std::string & s3 = "" )
sl@0:    // os is hint; implementation may ignore, particularly in embedded systems
sl@0:    : m_os(os), m_s1(s1), m_s2(s2), m_s3(s3) { restart(expected_count); }
sl@0: 
sl@0:   void           restart( unsigned long expected_count )
sl@0:   //  Effects: display appropriate scale
sl@0:   //  Postconditions: count()==0, expected_count()==expected_count
sl@0:   {
sl@0:     _count = _next_tic_count = _tic = 0;
sl@0:     _expected_count = expected_count;
sl@0: 
sl@0:     m_os << m_s1 << "0%   10   20   30   40   50   60   70   80   90   100%\n"
sl@0:          << m_s2 << "|----|----|----|----|----|----|----|----|----|----|"
sl@0:          << std::endl  // endl implies flush, which ensures display
sl@0:          << m_s3;
sl@0:     if ( !_expected_count ) _expected_count = 1;  // prevent divide by zero
sl@0:   } // restart
sl@0: 
sl@0:   unsigned long  operator+=( unsigned long increment )
sl@0:   //  Effects: Display appropriate progress tic if needed.
sl@0:   //  Postconditions: count()== original count() + increment
sl@0:   //  Returns: count().
sl@0:   {
sl@0:     if ( (_count += increment) >= _next_tic_count ) { display_tic(); }
sl@0:     return _count;
sl@0:   }
sl@0: 
sl@0:   unsigned long  operator++()           { return operator+=( 1 ); }
sl@0:   unsigned long  count() const          { return _count; }
sl@0:   unsigned long  expected_count() const { return _expected_count; }
sl@0: 
sl@0:   private:
sl@0:   std::ostream &     m_os;  // may not be present in all imps
sl@0:   const std::string  m_s1;  // string is more general, safer than 
sl@0:   const std::string  m_s2;  //  const char *, and efficiency or size are
sl@0:   const std::string  m_s3;  //  not issues
sl@0: 
sl@0:   unsigned long _count, _expected_count, _next_tic_count;
sl@0:   unsigned int  _tic;
sl@0:   void display_tic()
sl@0:   {
sl@0:     // use of floating point ensures that both large and small counts
sl@0:     // work correctly.  static_cast<>() is also used several places
sl@0:     // to suppress spurious compiler warnings. 
sl@0:     unsigned int tics_needed =
sl@0:       static_cast<unsigned int>(
sl@0:         (static_cast<double>(_count)/_expected_count)*50.0 );
sl@0:     do { m_os << '*' << std::flush; } while ( ++_tic < tics_needed );
sl@0:     _next_tic_count = 
sl@0:       static_cast<unsigned long>((_tic/50.0)*_expected_count);
sl@0:     if ( _count == _expected_count ) {
sl@0:       if ( _tic < 51 ) m_os << '*';
sl@0:       m_os << std::endl;
sl@0:       }
sl@0:   } // display_tic
sl@0: };
sl@0: 
sl@0: } // namespace boost
sl@0: 
sl@0: #endif  // BOOST_PROGRESS_HPP