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