[zypp-commit] r5467 - in /trunk/libzypp/zypp: ProgressData.cc ProgressData.h

Author: mlandres Date: Wed May 2 19:18:55 2007 New Revision: 5467 URL: http://svn.opensuse.org/viewcvs/zypp?rev=5467&view=rev Log: improve ProgressData Modified: trunk/libzypp/zypp/ProgressData.cc trunk/libzypp/zypp/ProgressData.h Modified: trunk/libzypp/zypp/ProgressData.cc URL: http://svn.opensuse.org/viewcvs/zypp/trunk/libzypp/zypp/ProgressData.cc?rev=5467&r1=5466&r2=5467&view=diff ============================================================================== --- trunk/libzypp/zypp/ProgressData.cc (original) +++ trunk/libzypp/zypp/ProgressData.cc Wed May 2 19:18:55 2007 @@ -27,8 +27,16 @@ // METHOD NAME : ProgressData::report // METHOD TYPE : void // - void ProgressData::report() + bool ProgressData::report() { + // DISABLED to get DBG output from 'if ( doReport )' + //if ( ! _d->_receiver ) + // return true; + + bool goOn = true; // continue per default + bool doReport = false; + + // compute value and check whether to report it if ( hasRange() ) { value_type newVal = _d->_val * 100; @@ -36,30 +44,50 @@ if ( newVal - _d->_last_val > 5 || Date::now() - _d->_last_send > 1 || _d->_state == END ) { - DBG << str::form( "{%u|%s}(%d%%)", - numericId(), name().c_str(), newVal ) << endl; _d->_last_val = newVal; _d->_last_send = Date::now(); - if ( _d->_state == INIT ) - { - _d->_state = RUN; - } + doReport = true; } } else { if ( Date::now() - _d->_last_send > 1 || _d->_state == END ) { - DBG << str::form( "{%u|%s}(%d!)", - numericId(), name().c_str(), _d->_val ) << endl; _d->_last_val = _d->_val; _d->_last_send = Date::now(); - if ( _d->_state == INIT ) - { - _d->_state = RUN; - } + doReport = true; + } + } + + // report if necessary + if ( doReport ) + { + if ( _d->_state == INIT ) + { + _d->_state = RUN; } + + if ( _d->_receiver ) + { + goOn = _d->_receiver( _d->_last_val ); + } + else + { + DBG << str::form( "{#%u|%s}(%lld%s)", + numericId(), name().c_str(), + _d->_last_val, ( hasRange() ? "%" : "!" ) ) << endl; + } + } + + // log abort request and return + if ( ! goOn && _d->_state != END ) + { + WAR << "User request to ABORT pending action. " + << str::form( "{#%u|%s}(%lld%s)", + numericId(), name().c_str(), + _d->_last_val, ( hasRange() ? "%" : "!" ) ) << endl; } + return goOn; } /****************************************************************** Modified: trunk/libzypp/zypp/ProgressData.h URL: http://svn.opensuse.org/viewcvs/zypp/trunk/libzypp/zypp/ProgressData.h?rev=5467&r1=5466&r2=5467&view=diff ============================================================================== --- trunk/libzypp/zypp/ProgressData.h (original) +++ trunk/libzypp/zypp/ProgressData.h Wed May 2 19:18:55 2007 @@ -16,6 +16,7 @@ #include <string> #include "zypp/base/PtrTypes.h" +#include "zypp/base/Function.h" #include "zypp/base/ProvideNumericId.h" #include "zypp/Date.h" @@ -47,9 +48,17 @@ { public: typedef long long value_type; - enum State { INIT, RUN, END }; + /** Most simple version of progress reporting - a single value. + * The percentage in most cases. Sometimes just keepalive. + * + * \todo tell recipient whether percentage or keepalive is sent + * and maybe tell whether task is abortable or not. + */ + typedef function ReceiverFnc; private: + enum State { INIT, RUN, END }; + class Data { public: @@ -59,14 +68,15 @@ {} public: - State _state; + State _state; std::string _name; - value_type _min; - value_type _max; - value_type _val; - - value_type _last_val; - Date _last_send; + value_type _min; + value_type _max; + value_type _val; + + ReceiverFnc _receiver; + value_type _last_val; + Date _last_send; private: /** clone for RWCOW_pointer */ @@ -105,27 +115,6 @@ } public: - /** @return Current \c min value. */ - value_type min() const - { return _d->_min; } - - /** @return Current \c max value. */ - value_type max() const - { return _d->_max; } - - /** @return Current counter \c value. */ - value_type val() const - { return _d->_val; } - - /** @return Wheter <tt>[min,max]</tt> defines a nonempty range. */ - bool hasRange() const - { return min() != max(); } - - /** @return The counters name. */ - const std::string & name() const - { return _d->_name; } - - public: /** Set new \c min value. */ void min( value_type min_r ) { _d->_min = min_r; } @@ -147,41 +136,87 @@ { min( min_r ); max( max_r ); } public: + /** Set counter name. */ + void name( const std::string & name_r ) + { _d->_name = name_r; } + + /** Set ReceiverFnc. */ + void sendTo( ReceiverFnc fnc_r ) + { _d->_receiver = fnc_r; } + + /** Set no ReceiverFnc. */ + void noSend() + { _d->_receiver = ReceiverFnc(); } + + public: + /** \name Progress reporting. + * + * These methods may actually cause a progress report to be sent. + * + * All methods return \c bool, because a progress receiver may + * return \c false to indicate the desire to abort the pending + * action. The incident is logged, but it's finaly up to the caller + * to honor this. + */ + //@{ + /** Set new counter \c value. */ - void set( value_type val_r ) + bool set( value_type val_r ) { _d->_val = val_r; - report(); + return report(); } /** Increment counter \c value (default by 1). */ - void incr( value_type val_r = 1 ) - { set( val() + val_r ); } + bool incr( value_type val_r = 1 ) + { return set( val() + val_r ); } /** Decrement counter \c value (default by 1). */ - void decr( value_type val_r = 1 ) - { set( val() - val_r ); } + bool decr( value_type val_r = 1 ) + { return set( val() - val_r ); } /** Set counter value to current \c min value. */ - void toMin() - { set( min() ); } + bool toMin() + { return set( min() ); } /** Set counter value to current \c max value (unless no range). */ - void toMax() - { if ( hasRange() ) set( max() ); } + bool toMax() + { return set( hasRange() ? max() : val() ); } /** Leave counter value unchanged (still alive). */ - void tick() - { set( val() ); } + bool tick() + { return set( val() ); } + + //@} public: - /** Set counter name. */ - void name( const std::string & name_r ) - { _d->_name = name_r; } + /** @return Current \c min value. */ + value_type min() const + { return _d->_min; } + + /** @return Current \c max value. */ + value_type max() const + { return _d->_max; } + + /** @return Current counter \c value. */ + value_type val() const + { return _d->_val; } + + /** @return Wheter <tt>[min,max]</tt> defines a nonempty range. */ + bool hasRange() const + { return min() != max(); } + + /** @return The counters name. */ + const std::string & name() const + { return _d->_name; } + + /** @return The ReceiverFnc. */ + ReceiverFnc receiver() const + { return _d->_receiver; } private: /** Send report if necessary. */ - void report(); + bool report(); /** Pointer to data. */ RWCOW_pointer<Data> _d; -- To unsubscribe, e-mail: zypp-commit+unsubscribe@opensuse.org For additional commands, e-mail: zypp-commit+help@opensuse.org