///////////////////////////////////////////////////////////////////
namespace zypp
{ /////////////////////////////////////////////////////////////////
+
///////////////////////////////////////////////////////////////////
namespace ui
{ /////////////////////////////////////////////////////////////////
//
/** Collects PoolItems of same kind and name.
*
- * Selectable is a status wrapper. That's why it offers the
- * PoolItems ResObjects but hides their individual ResStatus.
- * The ui::Status is calculated from (and transated to)
- * PoolItems individual ResStatus values.
+ * Selectable is a status wrapper. The ui::Status is calculated
+ * from (and transated to) \ref PoolItems individual \ref ResStatus
+ * values.
+ *
+ * Available objects are sorted according the solver policies, 'best'
+ * packages first (e.g. by repository priority, then Arch, then Edition).
*
- * \note There's one Selectable per installed item, in case more
- * than one item is intalled.
+ * Installed objects are sorted according the installation date, newer install
+ * time first.
*/
class Selectable : public base::ReferenceCounted, private base::NonCopyable
{
typedef SelectableTraits::installed_iterator installed_iterator;
typedef SelectableTraits::installed_size_type installed_size_type;
+ typedef SelectableTraits::picklist_iterator picklist_iterator;
+ typedef SelectableTraits::picklist_size_type picklist_size_type;
+
+ public:
+ /** \name Static ctor substitues picking the item from the pool.
+ * \code
+ * Selectable::Ptr item;
+ * item = Selectable::get( "amarok ); // package amamrok
+ * item = Selectable::get( ResKind::patch, "amarok ); // patch amamrok
+ * item = Selectable::get( IdString( "patch:amarok" ); // patch amamrok
+ * \endcode
+ */
+ //@{
+ /** Get the \ref Selctable */
+ static Ptr get( const pool::ByIdent & ident_r );
+
+ /** Get the \ref Selctable by it's \c sat-identifyer. */
+ static Ptr get( IdString ident_r )
+ { return get( pool::ByIdent( ident_r ) ); }
+
+ /** Get the \ref Selctable by \c kind and \c name. */
+ static Ptr get( ResKind kind_r, const std::string & name_r )
+ { return get( pool::ByIdent( kind_r, name_r ) ); }
+
+ /** Get the \c Package \ref Selctable by \c name. */
+ static Ptr get( const std::string & name_r )
+ { return get( pool::ByIdent( ResKind::package, name_r ) ); }
+
+ /** Get the \ref Selctable containing a specific \ref sat::Solvable. */
+ static Ptr get( const sat::Solvable & solv_r )
+ { return get( pool::ByIdent( solv_r ) ); }
+
+ /** Get the \ref Selctable containing a specific \ref ResObject. */
+ static Ptr get( const ResObject::constPtr & resolvable_r )
+ { return resolvable_r ? get( resolvable_r->satSolvable() ) : Ptr(); }
+
+ /** Get the \ref Selctable containing a specific \ref PoolItem. */
+ static Ptr get( const PoolItem & pi_r )
+ { return get( pi_r.satSolvable() ); }
+ //@}
+
public:
/** The identifier.
* This is the solvables \ref name, \b except for packages and
/** The last Installed object. */
PoolItem installedObj() const;
- /** Best among available objects.
- * The user selected candiate, or a default.
+ /** The 'best' or 'most interesting' among all available objects.
+ * One that is, or is likely to be, chosen for installation, unless
+ * it violated any solver policy (see \ref updateCandidateObj).
*/
PoolItem candidateObj() const;
+ /** The best candidate provided by a specific \ref Repository, if there is one.
+ * In contrary to \ref candidateObj, this may return no item even if
+ * there are available objects. This simply means the \ref Repository
+ * does not provide this object.
+ */
+ PoolItem candidateObjFrom( Repository repo_r ) const;
+
+ /** The best candidate for update, if there is one.
+ * In contrary to \ref candidateObj, this may return no item even if
+ * there are available objects. This simply means the best object is
+ * already installed, and all available objects violate at least one
+ * update policy.
+ */
+ PoolItem updateCandidateObj() const;
+
+ /** Simply the highest available version, ignoring priorities and policies.
+ * It's doubtful whether solely looking at the version makes a good
+ * candidate, but apps ask for it. Beware that different vendors may
+ * use different (uncomparable) version schemata.
+ */
+ PoolItem highestAvailableVersionObj() const;
+
+ /** \c True if \a rhs is installed and one with the same content is available.
+ * Basically the same name, edition, arch, vendor and buildtime.
+ * \see \ref sat::Solvable::identical
+ */
+ bool identicalAvailable( const PoolItem & rhs ) const;
+
+ /** \c True if \a rhs has the same content as an installed one.
+ * Basically the same name, edition, arch, vendor and buildtime.
+ * \see \ref sat::Solvable::identical
+ */
+ bool identicalInstalled( const PoolItem & rhs ) const;
+
+ /** \c True if the \ref candidateObj is installed (same content).
+ * \see \ref identicalInstalled.
+ */
+ bool identicalInstalledCandidate() const
+ { return identicalInstalled( candidateObj() ); }
+
+ /** \c True if the \ref updateCandidateObj is installed (same content).
+ * \see \ref identicalInstalled.
+ */
+ bool identicalInstalledUpdateCandidate() const
+ { return identicalInstalled( updateCandidateObj() ); }
+
+ /** Return an available Object with the same content as \c rhs.
+ * Basically the same name, edition, arch, vendor and buildtime.
+ * \see \ref sat::Solvable::identical
+ */
+ PoolItem identicalAvailableObj( const PoolItem & rhs ) const;
+
+ /** \Return an installed Object with the same content as \c rhs.
+ * Basically the same name, edition, arch, vendor and buildtime.
+ * \see \ref sat::Solvable::identical
+ */
+ PoolItem identicalInstalledObj( const PoolItem & rhs ) const;
+
+ /** Return the \ref installedObj resolvable casted to a specific kind.
+ * \code
+ * Selectable mySelectable;
+ * Package::constPtr p( mySelectable.installedAsKind<Package>() );
+ * \endcode
+ */
+ template<class _Res>
+ typename ResTraits<_Res>::constPtrType installedAsKind() const
+ { return asKind<_Res>( candidateObj() ); }
+
+ /** Return the \ref candidateObj resolvable casted to a specific kind.
+ * \code
+ * Selectable mySelectable;
+ * Package::constPtr p( mySelectable.candidateAsKind<Package>() );
+ * \endcode
+ */
+ template<class _Res>
+ typename ResTraits<_Res>::constPtrType candidateAsKind() const
+ { return asKind<_Res>( candidateObj() ); }
+
/** Set a candidate (out of available objects).
* \return The new candidate, or NULL if choice was invalid
* (NULL or not among availableObjs). An invalid choice
* selects the default candidate.
+ * In case the causer is not \c ResStatus::USER the operation
+ * may also fail if there are insufficient permissions to change
+ * a transacting candidate.
*/
- PoolItem setCandidate( ResObject::constPtr byUser_r );
+ PoolItem setCandidate( const PoolItem & newCandidate_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
+ /** \overload */
+ PoolItem setCandidate( ResObject::constPtr newCandidate_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
+
+ /** Arrange the specified candidate (out of available objects) to be on system after commit.
+ * If the specified candidate is not already installed (\ref identicalInstalled),
+ * and the \a causer_r has sufficient permisssion, then \a newCandidate_r is set as the new
+ * candidate (\ref setCandidate) and selected for installation.
+ * \returns \c True if \a newCandidate_r is already installed or successfully selected for installation.
+ */
+ bool setOnSystem( const PoolItem & newCandidate_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
- /** Best among all objects. */
+ /** An object you could use as pars pro toto.
+ *
+ * \return the \ref candidateObj, or ,if no available objects
+ * exist, the \ref installedObj.
+ */
PoolItem theObj() const;
////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////
- /** \name Insatlled objects iterators.
+ /** \name Installed objects iterators.
* Ordered by install time. Latest first.
*/
//@{
////////////////////////////////////////////////////////////////////////
+ /** \name picklist iterators.
+ * This is basically the available items list prepended by those
+ * installed items, that are nolonger \ref identicalAvailable.
+ */
+ //@{
+ bool picklistEmpty() const;
+ picklist_size_type picklistSize() const;
+ picklist_iterator picklistBegin() const;
+ picklist_iterator picklistEnd() const;
+ //}
+
+ ////////////////////////////////////////////////////////////////////////
+
public:
/** \name Query for objects within this Selectable.
*/
/** True if candidate object is present. */
bool hasCandidateObj() const
- { return candidateObj(); }
+ { return bool(candidateObj()); }
/** True if installed and candidate object is present */
bool hasBothObjects() const
*/
bool isUnmaintained() const;
- /** \name Classification of available patches (patterns).
+ /** \name Multiversion install.
+ *
+ * Using \ref pickInstall or \ref pickDelete with non-multiversionInstall items
+ * is possible, but additional constraints will apply. E.g. selecting one item for
+ * install will deselect any other.
+ */
+ //@{
+ /** Whether different versions of this package can be installed at the same time.
+ * Per default \c false. \see also \ref ZConfig::multiversion.
+ */
+ bool multiversionInstall() const;
+
+ /** Select a specific available item for installation.
+ */
+ bool pickInstall( const PoolItem & pi_r, ResStatus::TransactByValue causer_r = ResStatus::USER, bool yesno_r = true );
+
+ /** Deselect a specific available item from installation.
+ */
+ bool pickNoInstall( const PoolItem & pi_r, ResStatus::TransactByValue causer_r = ResStatus::USER )
+ { return pickInstall( pi_r, causer_r, false ); }
+
+ /** Select a specific installed item for deletion.
+ */
+ bool pickDelete( const PoolItem & pi_r, ResStatus::TransactByValue causer_r = ResStatus::USER, bool yesno_r = true );
+
+ /** Deselect a specific installed item from deletion.
+ */
+ bool pickNoDelete( const PoolItem & pi_r, ResStatus::TransactByValue causer_r = ResStatus::USER )
+ { return pickDelete( pi_r, causer_r, false ); }
+
+ /** Compute the \ref ui::Status for an individual PoolItem.
+ * This just takes into account the item and any identical
+ * installed (or available) one.
+ * \code
+ * Assume there are 3 identical 'foo-1.1 (vendor A)' items,
+ * one 'foo-2.1 (vendor A)' and one ''foo-1.1 (vendor B)':
+ *
+ * installed: . foo-1.1 (vendor A) -> S_KeepInstalled
+ * available: foo-2.1 (vendor A) (repo 1) -> S_NoInst
+ * . foo-1.1 (vendor A) (repo 1) -> S_KeepInstalled
+ * . foo-1.1 (vendor A) (repo 2) -> S_KeepInstalled
+ * foo-1.1 (vendor B) (repo 3) -> S_NoInst
+ *
+ * After 'foo-1.1 (vendor A) (repo 1)' was selected to be installed:
+ *
+ * installed: . foo-1.1 (vendor A) -> S_Update
+ * available: foo-2.1 (vendor A) (repo 1) -> S_NoInst
+ * I foo-1.1 (vendor A) (repo 1) -> S_Update
+ * . foo-1.1 (vendor A) (repo 2) -> S_KeepInstalled
+ * foo-1.1 (vendor B) (repo 3) -> S_NoInst
+ * \endcode
+ * \see \ref sat::Solvable::identical
+ */
+ Status pickStatus( const PoolItem & pi_r ) const;
+
+ /** Assign a new status to a specific item. */
+ bool setPickStatus( const PoolItem & pi_r, Status state_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
+ //@}
+
+ /** \name Classification of available patches (pseudo installed items).
* A patch is either \c not \c relevant, \c satisfied or \c broken.
+ * The same applies to other pseudo installed kinds.
+ * \see \ref traits::isPseudoInstalled
*/
//@{
/** Returns true for packages, because packages are not
* classified by the solver.
- */
+ */
bool isUndetermined() const;
/** Returns true if the patch is relevant which means that at least
/** Whether a relevant patchs requirements are broken. */
bool isBroken() const;
- /** This includes still broken patches, as well as those already
- * selected to be installed.
- * This is because already selected patches will be classified as
- * \c satisfied.
+ /** This includes \c unlocked broken patches, as well as those already
+ * selected to be installed. This is because already selected
+ * patches will be classified as \c satisfied. \c Locked but broken
+ * patches will be classified as \ref isUnwanted.
*/
bool isNeeded() const;
+
+ /** Broken (needed) but locked patches. */
+ bool isUnwanted() const;
//@}
public:
- /** \name Query objects fate in case of commit.
- */
+ /** \name Query and maip objects fate in case of commit.
+ */
//@{
enum Fate {
TO_DELETE = -1,
/** */
Fate fate() const;
- /** True if either to delete or to install */
+ /** True if neither to delete or to install */
bool unmodified() const
{ return fate() == UNMODIFIED; }
+ /** True if locked (subclass of unmodified). */
+ bool locked() const
+ { Status st( status() ); return( st == S_Protected || st == S_Taboo ); }
+
/** True if either to delete or to install */
bool toModify() const
{ return fate() != UNMODIFIED; }
/** True if to install */
bool toInstall() const
{ return fate() == TO_INSTALL; }
+
+ /** True if would be on system after commit. */
+ bool onSystem() const
+ { return( ( hasInstalledObj() && !toDelete() )
+ ||( hasCandidateObj() && toInstall() ) ); }
+
+ /** True if would be off system after commit. */
+ bool offSystem() const
+ { return ! onSystem(); }
+
+ /** */
+ bool setFate( Fate fate_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
+
+ /** Set the item to be installed (new- or re-install). */
+ bool setToInstall( ResStatus::TransactByValue causer_r = ResStatus::USER )
+ { return setFate( TO_INSTALL, causer_r ); }
+
+ /** Take care the item gets installed if it is not. */
+ bool setInstalled( ResStatus::TransactByValue causer_r = ResStatus::USER );
+
+ /** Take care the item gets installed if it is not, or is older. */
+ bool setUpToDate( ResStatus::TransactByValue causer_r = ResStatus::USER );
+
+ /** Set the item to be deleted (must be installed). */
+ bool setToDelete( ResStatus::TransactByValue causer_r = ResStatus::USER )
+ { return setFate( TO_DELETE, causer_r ); }
+
+ /** Take care the item gets deleted if it is installed. */
+ bool setDeleted( ResStatus::TransactByValue causer_r = ResStatus::USER );
+
+ /** Set the item to stay unmodified. */
+ bool unset( ResStatus::TransactByValue causer_r = ResStatus::USER )
+ { return setFate( UNMODIFIED, causer_r ); }
//@}
public:
* \name Special inteface for Y2UI.
* \note This interface acts on \ref ResStatus::USER level.
* The \ref Status enum, and allowed state transitions are
- * tightly related to the Y2UI. It might be not verry usefull
- * outside the Y2UI.
+ * tightly related to the Y2UI.
*/
//@{
/** Return the current Status */
* Try to set a new Status.
* Returns \c false if the transitions is not allowed.
*/
- bool setStatus( const Status state_r );
+ bool setStatus( Status state_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
/** Return who caused the modification. */
ResStatus::TransactByValue modifiedBy() const;
projects / platform / upstream / libzypp.git / blobdiff