progressdata.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_CORE_UI_PROGRESSDATA_H
#define ZYPP_CORE_UI_PROGRESSDATA_H
 
#include <iosfwd>
#include <string>
#include <chrono>
 
#include <zypp/base/PtrTypes.h>
#include <zypp/base/Function.h>
#include <zypp-core/base/ProvideNumericId>
 
#include <zypp/Date.h>

namespace zypp
{ 

  //
  //    CLASS NAME : ProgressData
  //
  class ZYPP_API ProgressData : public base::ProvideNumericId<ProgressData,unsigned>
  {
    public:
      using value_type = long long;
      using ReceiverFnc = function<bool (const ProgressData &)>;
 
    private:
      enum State { INIT, RUN, END };
 
      class Data
      {
        public:
          using TimePoint = std::chrono::steady_clock::time_point;
 
          Data( value_type min_r, value_type max_r, value_type val_r )
          : _state( INIT ), _min( min_r ), _max( max_r ), _val( val_r )
          , _last_val( 0 )
          {}
 
        public:
          State       _state;
          std::string _name;
          value_type  _min;
          value_type  _max;
          value_type  _val;
 
          ReceiverFnc _receiver;
          value_type  _last_val;
          TimePoint   _last_send;
 
        private:
          friend Data * rwcowClone<Data>( const Data * rhs );
          Data * clone() const { return new Data( *this ); }
      };
 
    public:
      ProgressData()
      : _d( new Data( 0, 0, 0 ) )
      {}

      ProgressData( value_type max_r )
      : _d( new Data( 0, max_r, 0 ) )
      {}

      ProgressData( value_type min_r, value_type max_r )
      : _d( new Data( min_r, max_r, min_r ) )
      {}

      ProgressData( value_type min_r, value_type max_r, value_type val_r )
      : _d( new Data( min_r, max_r, val_r ) )
      {}
 
      ~ProgressData()
      {
        if ( _d->_state == RUN )
        {
          _d->_state = END;
          report();
        }
      }
 
    public:
      void min( value_type min_r )
      { _d->_min = min_r; }

      void max( value_type max_r )
      { _d->_max = max_r; }

      void noRange()
      { range( 0, 0 ); }

      void range( value_type max_r )
      { range( 0, max_r ); }

      void range( value_type min_r, value_type max_r )
      { min( min_r ); max( max_r ); }
 
    public:
      void name( const std::string & name_r )
      { _d->_name = name_r; }

      void sendTo( const ReceiverFnc & fnc_r )
      { _d->_receiver = fnc_r; }

      void noSend()
      { _d->_receiver = ReceiverFnc(); }
 
    public:

      bool set( value_type val_r )
      {
        _d->_val = val_r;
        return report();
      }

      bool set( const ProgressData & rhs )
      {
        min( rhs.min() );
        max( rhs.max() );
        return set( rhs.val() );
      }

      bool incr( value_type val_r = 1 )
      { return set( val() + val_r ); }

      bool decr( value_type val_r = 1 )
      { return set( val() - val_r ); }

      bool toMin()
      { return set( min() ); }

      bool toMax()
      { return hasRange() ? set( max() ) : tick(); }

      bool tick()
      { return report(); }

 
    public:

      value_type min() const
      { return _d->_min; }

      value_type max() const
      { return _d->_max; }

      value_type val() const
      { return _d->_val; }

      bool hasRange() const
      { return min() != max(); }

      bool reportPercent() const
      { return hasRange(); }

      bool reportAlive() const
      { return ! hasRange(); }

      value_type reportValue() const
      { return hasRange() ? val() * 100 / ( max() - min() ) : -1; }

      const std::string & name() const
      { return _d->_name; }

      const ReceiverFnc & receiver() const
      { return _d->_receiver; }

      bool finalReport() const
      { return( _d->_state == END ); }

 
    private:
      bool report();

      RWCOW_pointer<Data> _d;
  };


  std::ostream & operator<<( std::ostream & str, const ProgressData & obj );

 
  class InputStream;
  ProgressData makeProgressData( const InputStream & input_r );


  class ZYPP_API CombinedProgressData
  {
  public:
    CombinedProgressData( ProgressData &pd,
                          ProgressData::value_type weight = 0 );

    bool operator()( const ProgressData &progress );
 
  private:
    ProgressData::value_type _weight;
    ProgressData::value_type _last_value;
    ProgressData &_pd;
  };

} // namespace zypp
#endif // ZYPP_CORE_UI_PROGRESSDATA_H