ResStatus.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_RESSTATUS_H
#define ZYPP_RESSTATUS_H
 
#include <inttypes.h>
#include <iosfwd>
#include <zypp/Bit.h>
#include <zypp/Globals.h>

namespace zypp
{ 
 
  namespace resstatus
  {
    struct UserLockQueryManip;
    class StatusBackup;
  }

  //
  //    CLASS NAME : ResStatus
  //
  class ZYPP_API ResStatus
  {
    friend std::ostream & operator<<( std::ostream & str, const ResStatus & obj );
    friend bool operator==( const ResStatus & lhs, const ResStatus & rhs );
 
  public:
    using FieldType = uint16_t;
    using BitFieldType = bit::BitField<FieldType>;
    // Bit Ranges within FieldType defined by 1st bit and size:
    using StateField            = bit::Range<FieldType, 0                         , 1>;
    using ValidateField         = bit::Range<FieldType, StateField::end           , 2>;
    using TransactField         = bit::Range<FieldType, ValidateField::end        , 2>;
    using TransactByField       = bit::Range<FieldType, TransactField::end        , 2>;
    using TransactDetailField   = bit::Range<FieldType, TransactByField::end      , 2>;
    using LicenceConfirmedField = bit::Range<FieldType, TransactDetailField::end  , 1>;
    using WeakField             = bit::Range<FieldType, LicenceConfirmedField::end, 4>;
    using UserLockQueryField    = bit::Range<FieldType, WeakField::end            , 1>; // internal
    // enlarge FieldType if more bits are needed. It's not yet
    // checked by the compiler.
  public:

    enum StateValue
      {
        UNINSTALLED = bit::RangeValue<StateField,0>::value,
        INSTALLED   = bit::RangeValue<StateField,1>::value
      };
    enum ValidateValue
      {
        UNDETERMINED = bit::RangeValue<ValidateField,0>::value,
        BROKEN       = bit::RangeValue<ValidateField,1>::value,
        SATISFIED    = bit::RangeValue<ValidateField,2>::value,
        NONRELEVANT  = bit::RangeValue<ValidateField,3>::value
      };
    enum TransactValue
      {
        KEEP_STATE = bit::RangeValue<TransactField,0>::value,
        LOCKED     = bit::RangeValue<TransactField,1>::value, // locked, must not transact
        TRANSACT   = bit::RangeValue<TransactField,2>::value  // transact according to state
      };
    enum TransactByValue
      {
        SOLVER    = bit::RangeValue<TransactByField,0>::value,
        APPL_LOW  = bit::RangeValue<TransactByField,1>::value,
        APPL_HIGH = bit::RangeValue<TransactByField,2>::value,
        USER      = bit::RangeValue<TransactByField,3>::value
      };
 
    enum DetailValue
      {
        NO_DETAIL = bit::RangeValue<TransactDetailField,0>::value,
      };
    enum InstallDetailValue
      {
        EXPLICIT_INSTALL = bit::RangeValue<TransactDetailField,0>::value,
        SOFT_INSTALL     = bit::RangeValue<TransactDetailField,1>::value
      };
    enum RemoveDetailValue
      {
        EXPLICIT_REMOVE = bit::RangeValue<TransactDetailField,0>::value,
        SOFT_REMOVE     = bit::RangeValue<TransactDetailField,1>::value,
        DUE_TO_OBSOLETE = bit::RangeValue<TransactDetailField,2>::value,
        DUE_TO_UPGRADE  = bit::RangeValue<TransactDetailField,3>::value
      };
 
    enum LicenceConfirmedValue
      {
        LICENCE_UNCONFIRMED = bit::RangeValue<LicenceConfirmedField,0>::value,
        LICENCE_CONFIRMED   = bit::RangeValue<LicenceConfirmedField,1>::value
      };
 
    enum WeakValue     // Unlike the other fields those are BITS that may be or'ed!
      {
        NO_WEAK          = bit::RangeValue<WeakField,0>::value,
        SUGGESTED              = bit::RangeValue<WeakField,1<<0>::value,
        RECOMMENDED          = bit::RangeValue<WeakField,1<<1>::value,
        ORPHANED                = bit::RangeValue<WeakField,1<<2>::value,
        UNNEEDED                = bit::RangeValue<WeakField,1<<3>::value
      };
 
    enum UserLockQuery // internal
      {
        USERLOCK_NOMATCH        = bit::RangeValue<UserLockQueryField,0>::value,
        USERLOCK_MATCH            = bit::RangeValue<UserLockQueryField,1>::value
      };

 
  public:

    ResStatus();

    ResStatus( bool isInstalled_r );

    ~ResStatus();
 
    ResStatus(const ResStatus &) = default;
    ResStatus(ResStatus &&) noexcept = default;
    ResStatus &operator=(const ResStatus &) = default;
    ResStatus &operator=(ResStatus &&) noexcept = default;

    BitFieldType bitfield() const
    { return _bitfield; }
 
  public:
 
    bool isLicenceConfirmed() const
    { return fieldValueIs<LicenceConfirmedField>( LICENCE_CONFIRMED ); }
 
    void setLicenceConfirmed( bool toVal_r = true )
    { fieldValueAssign<LicenceConfirmedField>( toVal_r ? LICENCE_CONFIRMED : LICENCE_UNCONFIRMED ); }
 
  public:
    bool isRecommended() const
    { return _bitfield.test( RECOMMENDED ); }
 
    bool isSuggested() const
    { return _bitfield.test( SUGGESTED ); }
 
    bool isOrphaned() const
    { return _bitfield.test( ORPHANED ); }
 
    bool isUnneeded() const
    { return _bitfield.test( UNNEEDED ); }
 
    bool hasWeak() const
    { return ! fieldValueIs<WeakField>( NO_WEAK ); }
 
    void resetWeak()
    { return fieldValueAssign<WeakField>( NO_WEAK ); }
 
    void setRecommended( bool toVal_r = true )
    { _bitfield.set( RECOMMENDED, toVal_r ); }
 
    void setSuggested( bool toVal_r = true )
    { _bitfield.set( SUGGESTED, toVal_r ); }
 
    void setOrphaned( bool toVal_r = true )
    { _bitfield.set( ORPHANED, toVal_r ); }
 
    void setUnneeded( bool toVal_r = true )
    { _bitfield.set( UNNEEDED, toVal_r ); }
 
  public:
    ValidateValue validate() const
    { return (ValidateValue)_bitfield.value<ValidateField>(); }
 
    bool isUndetermined() const
    { return fieldValueIs<ValidateField>( UNDETERMINED ); }
 
    bool isSatisfied() const
    { return fieldValueIs<ValidateField>( SATISFIED ); }
 
    bool isBroken() const
    { return fieldValueIs<ValidateField>( BROKEN ); }
 
    bool isNonRelevant() const
    { return fieldValueIs<ValidateField>( NONRELEVANT ); }
 
    std::string validateValueAsString() const
    { return validateValueAsString( validate() ); }

    static std::string validateValueAsString( ValidateValue val_r );

    static ValidateValue stringToValidateValue( const std::string & str_r );
 
  public:
    // These two are IMMUTABLE!
 
    bool isInstalled() const
    { return fieldValueIs<StateField>( INSTALLED ); }
 
    bool isUninstalled() const
    { return fieldValueIs<StateField>( UNINSTALLED ); }
 
  public:
 
    bool staysInstalled() const
    { return isInstalled() && !transacts(); }
 
    bool wasInstalled() const { return staysInstalled(); }    //for old status
 
    bool isToBeInstalled() const
    { return isUninstalled() && transacts(); }
 
    bool staysUninstalled() const
    { return isUninstalled() && !transacts(); }
 
    bool wasUninstalled() const { return staysUninstalled(); }    // for old status
 
    bool isToBeUninstalled() const
    { return isInstalled() && transacts(); }
 
    bool isLocked() const
    { return fieldValueIs<TransactField>( LOCKED ); }
 
    bool isUserLocked() const
    { return isLocked() && isByUser(); }
 
    bool isSoftLocked() const
    { return isKept() && ( isByApplLow() || isByUser() ); }
 
    bool isKept() const
    { return fieldValueIs<TransactField>( KEEP_STATE ); }
 
    bool transacts() const
    { return fieldValueIs<TransactField>( TRANSACT ); }
 
    TransactValue getTransactValue() const
    { return (TransactValue)_bitfield.value<TransactField>(); }

    bool onSystem() const
    { return( isInstalled() != transacts() ); }

    bool offSystem() const
    { return ! onSystem(); }
 
    bool isBySolver() const
    { return fieldValueIs<TransactByField>( SOLVER ); }
 
    bool isByApplLow() const
    { return fieldValueIs<TransactByField>( APPL_LOW ); }
 
    bool isByApplHigh() const
    { return fieldValueIs<TransactByField>( APPL_HIGH ); }
 
    bool isByUser() const
    { return fieldValueIs<TransactByField>( USER ); }
 
    TransactByValue getTransactByValue() const
    { return (TransactByValue)_bitfield.value<TransactByField>(); }
 
    bool setTransactByValue(TransactByValue causer)
    {
        if ( isLessThan<TransactByField>( causer ) ) {
            fieldValueAssign<TransactByField>( causer );
            return true;
        } else {
            return false;
        }
    }
 
    bool isToBeUninstalledDueToObsolete () const
    { return isToBeUninstalled() && fieldValueIs<TransactDetailField>( DUE_TO_OBSOLETE ); }
 
    bool isToBeUninstalledDueToUpgrade() const
    { return isToBeUninstalled() && fieldValueIs<TransactDetailField>( DUE_TO_UPGRADE ); }
 
    bool isToBeInstalledSoft () const
    { return isToBeInstalled() && fieldValueIs<TransactDetailField>( SOFT_INSTALL ); }
 
    bool isToBeInstalledNotSoft () const
    { return isToBeInstalled() && !fieldValueIs<TransactDetailField>( SOFT_INSTALL ); }
 
    bool isToBeUninstalledSoft () const
    { return isToBeUninstalled() && fieldValueIs<TransactDetailField>( SOFT_REMOVE ); }
 
  private:
    friend struct resstatus::UserLockQueryManip;
 
    void setUserLockQueryMatch( bool match_r )
    { fieldValueAssign<UserLockQueryField>( match_r ? USERLOCK_MATCH : USERLOCK_NOMATCH ); }

  public:
    bool isUserLockQueryMatch() const
    { return fieldValueIs<UserLockQueryField>( USERLOCK_MATCH ); }
 
  public:
 
    //------------------------------------------------------------------------
    // get/set functions, returning \c true if requested status change
    // was successful (i.e. leading to the desired transaction).
    // If a lower level (e.g.SOLVER) wants to transact, but it's
    // already set by a higher level, \c true should be returned.
    // Removing a higher levels transaction bit should fail.
    //
    // The may functions checks only, if the action would return true
    // if it is called.

    bool setTransactValue( TransactValue newVal_r, TransactByValue causer_r )
    {
      switch ( newVal_r )
        {
        case KEEP_STATE:
          return setTransact( false, causer_r );
          break;
        case LOCKED:
          return setLock( true, causer_r );
          break;
        case TRANSACT:
          return setTransact( true, causer_r );
          break;
        }
      return false;
    }
 
    bool maySetTransactValue( TransactValue newVal_r, TransactByValue causer_r )
    {
        bit::BitField<FieldType> savBitfield = _bitfield;
        bool ret = setTransactValue( newVal_r, causer_r );
        _bitfield = savBitfield;
        return ret;
    }

    bool setLock( bool toLock_r, TransactByValue causer_r )
    {
      if ( toLock_r == isLocked() )
        {
          // we're already in the desired state, but in case of
          // LOCKED, remember a superior causer.
          if ( isLocked() && isLessThan<TransactByField>( causer_r ) )
            fieldValueAssign<TransactByField>( causer_r );
           return true;
        }
      // Here: Lock status is to be changed:
      if ( causer_r != USER && causer_r != APPL_HIGH )
        return false;
      if ( toLock_r ) {
        // We're in unlocked state, which includes TRANSACT.
        // Causer must be allowed to reset this. But from
        // KEEP_STATE every causer is allowed to set the lock.
        if ( ! setTransact( false, causer_r ) )
          return false;
        fieldValueAssign<TransactField>( LOCKED );
        fieldValueAssign<TransactByField>( causer_r );
      } else {
        // To leave Locked state it needs a superior causer.
        if ( isGreaterThan<TransactByField>( causer_r ) )
          return false;
        fieldValueAssign<TransactField>( KEEP_STATE );
        fieldValueAssign<TransactByField>( SOLVER ); // reset to lowest causer
                                                     // in order to distinguish from keep_state_by_user
      }
      return true;
    }
 
    bool maySetLock( bool to_r, TransactByValue causer_r )
    {
        bit::BitField<FieldType> savBitfield = _bitfield;
        bool ret = setLock( to_r, causer_r );
        _bitfield = savBitfield;
        return ret;
    }

    bool setTransact( bool toTansact_r, TransactByValue causer_r )
    {
      if ( toTansact_r == transacts() )
        {
          // we're already in the desired state, but in case of
          // TRANSACT, remember a superior causer.
          if ( transacts() && isLessThan<TransactByField>( causer_r ) )
              fieldValueAssign<TransactByField>( causer_r );
 
          fieldValueAssign<TransactDetailField>( NO_DETAIL ); // Details has to be set again
          return true;
        }
      // Here: transact status is to be changed:
      if (    ! fieldValueIs<TransactField>( KEEP_STATE )
              && isGreaterThan<TransactByField>( causer_r ) ) {
        return false;
      }
 
      if ( toTansact_r )
      {
          fieldValueAssign<TransactField>( TRANSACT );
      }
      else
      {
          fieldValueAssign<TransactField>( KEEP_STATE );
      }
      fieldValueAssign<TransactDetailField>( NO_DETAIL ); // Details has to be set again
      fieldValueAssign<TransactByField>( causer_r );
      return true;
    }
 
    bool maySetTransact( bool val_r, TransactByValue causer )
    {
        bit::BitField<FieldType> savBitfield = _bitfield;
        bool ret = setTransact (val_r, causer);
        _bitfield = savBitfield;
        return ret;
    }

    bool setSoftLock( TransactByValue causer_r )
    {
      if ( ! setTransact( false, causer_r ) )
        return false;
      if ( fieldValueIs<TransactField>( KEEP_STATE )
           && isLessThan<TransactByField>( causer_r ) )
        fieldValueAssign<TransactByField>( causer_r );
      return true;
    }

    bool resetTransact( TransactByValue causer_r )
    {
      if ( ! setTransact( false, causer_r ) )
        return false;
      if ( fieldValueIs<TransactField>( KEEP_STATE ) )
        fieldValueAssign<TransactByField>( SOLVER );
      return true;
    }

    bool setSoftTransact( bool toTansact_r, TransactByValue causer_r,
                          TransactByValue causerLimit_r )
    {
      if ( fieldValueIs<TransactField>( KEEP_STATE )
           && toTansact_r != transacts()
           && isGreaterThan<TransactByField>( causerLimit_r ) )
        {
          // any transact status change requires a superior causer.
          return false;
        }
      return setTransact( toTansact_r, causer_r );
    }
 
    bool setSoftTransact( bool toTansact_r, TransactByValue causer_r )
    { return setSoftTransact( toTansact_r, causer_r, causer_r ); }
 
    bool maySetSoftTransact( bool val_r, TransactByValue causer,
                             TransactByValue causerLimit_r )
    {
        bit::BitField<FieldType> savBitfield = _bitfield;
        bool ret = setSoftTransact( val_r, causer, causerLimit_r );
        _bitfield = savBitfield;
        return ret;
    }
 
    bool maySetSoftTransact( bool val_r, TransactByValue causer )
    { return maySetSoftTransact( val_r, causer, causer ); }
 
    bool setToBeInstalled (TransactByValue causer)
    {
      if (isInstalled()) return false;
      return setTransact (true, causer);
    }
 
    bool maySetToBeInstalled (TransactByValue causer)
    {
        bit::BitField<FieldType> savBitfield = _bitfield;
        bool ret = setToBeInstalled (causer);
        _bitfield = savBitfield;
        return ret;
    }
 
    bool setToBeUninstalled (TransactByValue causer)
    {
      if (!isInstalled()) return false;
      return setTransact (true, causer);
    }
 
    bool maySetToBeUninstalled (TransactByValue causer)
    {
        bit::BitField<FieldType> savBitfield = _bitfield;
        bool ret = setToBeUninstalled (causer);
        _bitfield = savBitfield;
        return ret;
    }
 
    //------------------------------------------------------------------------
    // *** These are only for the Resolver ***
 
    bool setToBeUninstalledDueToObsolete ( )
    {
      if (!setToBeUninstalled (SOLVER)) return false;
      fieldValueAssign<TransactDetailField>(DUE_TO_OBSOLETE);
      return true;
    }
 
    bool setToBeUninstalledDueToUpgrade ( TransactByValue causer )
    {
      if (!setToBeUninstalled (causer)) return false;
      fieldValueAssign<TransactDetailField>(DUE_TO_UPGRADE);
      return true;
    }
 
    bool setToBeInstalledSoft ( )
    {
      if (isInstalled()
          || !setSoftTransact (true, SOLVER))
          return false;
 
      fieldValueAssign<TransactDetailField>(SOFT_INSTALL);
      return true;
    }
 
    bool setToBeUninstalledSoft ( )
    {
      if (!isInstalled()
          || !setSoftTransact (true, SOLVER))
          return false;
 
      fieldValueAssign<TransactDetailField>(SOFT_REMOVE);
      return true;
    }
 
    bool maySetToBeUninstalledSoft ()
    {
        bit::BitField<FieldType> savBitfield = _bitfield;
        bool ret = setToBeUninstalledSoft ();
        _bitfield = savBitfield;
        return ret;
    }
 
    bool isSoftInstall () {
        return fieldValueIs<TransactDetailField> (SOFT_INSTALL);
    }
 
    bool isSoftUninstall () {
        return fieldValueIs<TransactDetailField> (SOFT_REMOVE);
    }
 
    bool setSoftInstall (bool flag) {
        fieldValueAssign<TransactDetailField>(flag?SOFT_INSTALL:0);
        return true;
    }
 
    bool setSoftUninstall (bool flag) {
        fieldValueAssign<TransactDetailField>(flag?SOFT_REMOVE:0);
        return true;
    }
 
    bool setUndetermined ()
    {
      fieldValueAssign<ValidateField>(UNDETERMINED);
      return true;
    }
 
    bool setSatisfied ()
    {
      fieldValueAssign<ValidateField>(SATISFIED);
      return true;
    }
 
    bool setBroken ()
    {
      fieldValueAssign<ValidateField>(BROKEN);
      return true;
    }
 
    bool setNonRelevant ()
    {
      fieldValueAssign<ValidateField>(NONRELEVANT);
      return true;
    }
 
    bool setStatus( const ResStatus& newStatus_r )
    {
      // State field is immutable!
      if ( _bitfield.value<StateField>() != newStatus_r._bitfield.value<StateField>() )
        return false;
      // Transaction state change allowed?
      if ( ! setTransactValue( newStatus_r.getTransactValue(), newStatus_r.getTransactByValue() ) )
        return false;
 
      // Ok, we take it all..
      _bitfield = newStatus_r._bitfield;
      return true;
    }

    static const ResStatus toBeInstalled;
    static const ResStatus toBeUninstalled;
    static const ResStatus toBeUninstalledDueToUpgrade;
    static const ResStatus toBeUninstalledDueToObsolete;
 
  private:
    ResStatus( StateValue s,
               ValidateValue v      = UNDETERMINED,
               TransactValue t      = KEEP_STATE,
               InstallDetailValue i = EXPLICIT_INSTALL,
               RemoveDetailValue r  = EXPLICIT_REMOVE );

    template<class TField>
      bool fieldValueIs( FieldType val_r ) const
    { return _bitfield.isEqual<TField>( val_r ); }

    template<class TField>
      void fieldValueAssign( FieldType val_r )
    { _bitfield.assign<TField>( val_r ); }

    template<class TField>
      bool isGreaterThan( FieldType val_r )
    { return _bitfield.value<TField>() > val_r; }
 
    template<class TField>
      bool isLessThan( FieldType val_r )
    { return _bitfield.value<TField>() < val_r; }
 
  private:
    friend class resstatus::StatusBackup;
    BitFieldType _bitfield;
  };


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

  std::ostream & operator<<( std::ostream & str, ResStatus::TransactValue obj ) ZYPP_API;

  std::ostream & operator<<( std::ostream & str, ResStatus::TransactByValue obj ) ZYPP_API;

  inline bool operator==( const ResStatus & lhs, const ResStatus & rhs )
  { return lhs._bitfield == rhs._bitfield; }

  inline bool operator!=( const ResStatus & lhs, const ResStatus & rhs )
  { return ! (lhs == rhs); }

 
  namespace resstatus
  {
    class StatusBackup
    {
      public:
        StatusBackup()
        : _status( 0 )
        {}
 
        StatusBackup( ResStatus & status_r )
        : _status( &status_r )
        , _bitfield( _status->_bitfield )
        {}
 
        void replay()
        { if ( _status ) _status->_bitfield = _bitfield; }
 
      private:
        ResStatus *             _status;
        ResStatus::BitFieldType _bitfield;
    };
  }

} // namespace zypp
#endif // ZYPP_RESSTATUS_H