libzypp  17.8.0
Selectable.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_UI_SELECTABLE_H
13 #define ZYPP_UI_SELECTABLE_H
14 
15 #include <iosfwd>
16 
18 #include "zypp/base/NonCopyable.h"
19 #include "zypp/base/PtrTypes.h"
20 #include "zypp/base/Iterator.h"
21 
23 #include "zypp/ui/Status.h"
24 
26 namespace zypp
27 {
28 
30  namespace ui
31  {
32 
33  DEFINE_PTR_TYPE(Selectable);
34 
36  //
37  // CLASS NAME : Selectable
38  //
52  {
53  friend std::ostream & operator<<( std::ostream & str, const Selectable & obj );
54  friend std::ostream & dumpOn( std::ostream & str, const Selectable & obj );
55 
56  public:
57  typedef intrusive_ptr<Selectable> Ptr;
58  typedef intrusive_ptr<const Selectable> constPtr;
59 
63 
66 
69 
70  public:
81  static Ptr get( const pool::ByIdent & ident_r );
82 
84  static Ptr get( IdString ident_r )
85  { return get( pool::ByIdent( ident_r ) ); }
86 
88  static Ptr get( ResKind kind_r, const std::string & name_r )
89  { return get( pool::ByIdent( kind_r, name_r ) ); }
90 
92  static Ptr get( const std::string & name_r )
93  { return get( pool::ByIdent( ResKind::package, name_r ) ); }
94 
96  static Ptr get( const sat::Solvable & solv_r )
97  { return get( pool::ByIdent( solv_r ) ); }
98 
100  static Ptr get( const ResObject::constPtr & resolvable_r )
101  { return resolvable_r ? get( resolvable_r->satSolvable() ) : Ptr(); }
102 
104  static Ptr get( const PoolItem & pi_r )
105  { return get( pi_r.satSolvable() ); }
107 
108  public:
114  IdString ident() const;
115 
117  ResKind kind() const;
118 
120  const std::string & name() const;
121 
123  PoolItem installedObj() const;
124 
129  PoolItem candidateObj() const;
130 
136  PoolItem candidateObjFrom( Repository repo_r ) const;
137 
145 
152 
154  bool identIsAutoInstalled() const;
155 
160  bool identicalAvailable( const PoolItem & rhs ) const;
161 
166  bool identicalInstalled( const PoolItem & rhs ) const;
167 
172  { return identicalInstalled( candidateObj() ); }
173 
178  { return identicalInstalled( updateCandidateObj() ); }
179 
184  PoolItem identicalAvailableObj( const PoolItem & rhs ) const;
185 
190  PoolItem identicalInstalledObj( const PoolItem & rhs ) const;
191 
198  template<class TRes>
200  { return asKind<TRes>( candidateObj() ); }
201 
208  template<class TRes>
210  { return asKind<TRes>( candidateObj() ); }
211 
220  PoolItem setCandidate( const PoolItem & newCandidate_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
223 
230  bool setOnSystem( const PoolItem & newCandidate_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
231 
237  PoolItem theObj() const;
238 
240 
245  bool availableEmpty() const;
250  { return makeIterable( availableBegin(), availableEnd() ); }
252 
254 
259  bool installedEmpty() const;
264  { return makeIterable( installedBegin(), installedEnd() ); }
266 
268 
274  bool picklistEmpty() const;
279  { return makeIterable( picklistBegin(), picklistEnd() ); }
280 
283 
288  picklist_size_type picklistPos( const PoolItem & pi_r ) const;
289 
291  picklist_size_type picklistPos( const sat::Solvable & solv_r ) const;
293 
295 
296  public:
301  bool hasObject() const
302  { return (! installedEmpty()) || candidateObj(); }
303 
305  bool hasInstalledObj() const
306  { return ! installedEmpty(); }
307 
309  bool hasCandidateObj() const
310  { return bool(candidateObj()); }
311 
313  bool hasBothObjects() const
314  { return (! installedEmpty()) && candidateObj(); }
315 
317  bool hasInstalledObjOnly() const
318  { return (! installedEmpty()) && ! candidateObj(); }
319 
321  bool hasCandidateObjOnly() const
322  { return ( installedEmpty() ) && candidateObj(); }
324 
329  bool isUnmaintained() const;
330 
342  bool multiversionInstall() const;
343 
346  bool pickInstall( const PoolItem & pi_r, ResStatus::TransactByValue causer_r = ResStatus::USER, bool yesno_r = true );
347 
351  { return pickInstall( pi_r, causer_r, false ); }
352 
355  bool pickDelete( const PoolItem & pi_r, ResStatus::TransactByValue causer_r = ResStatus::USER, bool yesno_r = true );
356 
360  { return pickDelete( pi_r, causer_r, false ); }
361 
385  Status pickStatus( const PoolItem & pi_r ) const;
386 
388  bool setPickStatus( const PoolItem & pi_r, Status state_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
390 
400  bool isUndetermined() const;
401 
405  bool isRelevant() const;
406 
408  bool isSatisfied() const;
409 
411  bool isBroken() const;
412 
418  bool isNeeded() const;
419 
421  bool isUnwanted() const;
423 
424  public:
428  enum Fate {
429  TO_DELETE = -1,
432  };
434  Fate fate() const;
435 
437  bool unmodified() const
438  { return fate() == UNMODIFIED; }
439 
441  bool locked() const
442  { Status st( status() ); return( st == S_Protected || st == S_Taboo ); }
443 
445  bool toModify() const
446  { return fate() != UNMODIFIED; }
447 
449  bool toDelete() const
450  { return fate() == TO_DELETE; }
451 
453  bool toInstall() const
454  { return fate() == TO_INSTALL; }
455 
457  bool onSystem() const
458  { return( ( hasInstalledObj() && !toDelete() )
459  ||( hasCandidateObj() && toInstall() ) ); }
460 
462  bool offSystem() const
463  { return ! onSystem(); }
464 
466  bool setFate( Fate fate_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
467 
470  { return setFate( TO_INSTALL, causer_r ); }
471 
474 
477 
480  { return setFate( TO_DELETE, causer_r ); }
481 
484 
487  { return setFate( UNMODIFIED, causer_r ); }
489 
490  public:
499  Status status() const;
500 
505  bool setStatus( Status state_r, ResStatus::TransactByValue causer_r = ResStatus::USER );
506 
509 
511  bool hasLicenceConfirmed() const;
512 
514  void setLicenceConfirmed( bool val_r = true );
516 
517  public:
519  class Impl;
520  typedef shared_ptr<Impl> Impl_Ptr;
522  Selectable( Impl_Ptr pimpl_r );
523  private:
525  ~Selectable();
526  private:
529  };
531 
533  std::ostream & operator<<( std::ostream & str, const Selectable & obj );
534 
536  std::ostream & dumpOn( std::ostream & str, const Selectable & obj );
537 
543  {
544  typedef Selectable_Ptr result_type;
545 
546  Selectable_Ptr operator()( const sat::Solvable & solv_r ) const;
547 
548  Selectable_Ptr operator()( const PoolItem & pi_r ) const
549  { return operator()( pi_r.satSolvable() ); }
550  };
551 
553  } // namespace ui
556 } // namespace zypp
558 #endif // ZYPP_UI_SELECTABLE_H
bool locked() const
True if locked (subclass of unmodified).
Definition: Selectable.h:441
PickList::const_iterator picklist_iterator
ResStatus::TransactByValue modifiedBy() const
Return who caused the modification.
Definition: Selectable.cc:217
A Solvable object within the sat Pool.
Definition: Solvable.h:53
Status
UI status Status values calculated by Selectable.
Definition: Status.h:34
bool toModify() const
True if either to delete or to install.
Definition: Selectable.h:445
intrusive_ptr< const TRes > constPtrType
Definition: ResTraits.h:83
static const ResKind package
Definition: ResKind.h:40
Collects PoolItems of same kind and name.
Definition: Selectable.h:51
PoolItem setCandidate(const PoolItem &newCandidate_r, ResStatus::TransactByValue causer_r=ResStatus::USER)
Set a candidate (out of available objects).
Definition: Selectable.cc:100
bool unmodified() const
True if neither to delete or to install.
Definition: Selectable.h:437
intrusive_ptr< Selectable > Ptr
Definition: Selectable.h:57
SelectableTraits::installed_iterator installed_iterator
Definition: Selectable.h:64
bool isBroken() const
Whether a relevant patchs requirements are broken.
Definition: Selectable.cc:204
PoolItem identicalAvailableObj(const PoolItem &rhs) const
Return an available Object with the same content as rhs.
Definition: Selectable.cc:94
available_iterator availableEnd() const
Definition: Selectable.cc:127
bool installedEmpty() const
Definition: Selectable.cc:132
bool hasCandidateObj() const
True if candidate object is present.
Definition: Selectable.h:309
PoolItem identicalInstalledObj(const PoolItem &rhs) const
an installed Object with the same content as rhs.
Definition: Selectable.cc:97
bool toInstall() const
True if to install.
Definition: Selectable.h:453
String related utilities and Regular expression matching.
Iterable< installed_iterator > installed() const
Definition: Selectable.h:263
Access to the sat-pools string space.
Definition: IdString.h:41
PoolItem updateCandidateObj() const
The best candidate for update, if there is one.
Definition: Selectable.cc:79
bool setToInstall(ResStatus::TransactByValue causer_r=ResStatus::USER)
Set the item to be installed (new- or re-install).
Definition: Selectable.h:469
bool offSystem() const
True if would be off system after commit.
Definition: Selectable.h:462
bool onSystem() const
True if would be on system after commit.
Definition: Selectable.h:457
static constexpr const picklist_size_type picklistNoPos
Returned by picklistPos if the Item does not belong to the picklist.
Definition: Selectable.h:282
TraitsType::constPtrType constPtr
Definition: ResObject.h:44
Selectable_Ptr operator()(const sat::Solvable &solv_r) const
IdString ident() const
The identifier.
Definition: Selectable.cc:55
picklist_size_type picklistPos(const PoolItem &pi_r) const
Return the position of pi_r in the piclist or picklistNoPos.
Definition: Selectable.cc:158
bool pickNoInstall(const PoolItem &pi_r, ResStatus::TransactByValue causer_r=ResStatus::USER)
Deselect a specific available item from installation.
Definition: Selectable.h:350
bool setStatus(Status state_r, ResStatus::TransactByValue causer_r=ResStatus::USER)
Try to set a new Status.
Definition: Selectable.cc:67
void setLicenceConfirmed(bool val_r=true)
Set LicenceConfirmed bit.
Definition: Selectable.cc:223
bool identicalInstalledUpdateCandidate() const
True if the updateCandidateObj is installed (same content).
Definition: Selectable.h:177
Fate fate() const
Definition: Selectable.cc:227
bool setOnSystem(const PoolItem &newCandidate_r, ResStatus::TransactByValue causer_r=ResStatus::USER)
Arrange the specified candidate (out of available objects) to be on system after commit.
Definition: Selectable.cc:106
PoolItem candidateObj() const
The &#39;best&#39; or &#39;most interesting&#39; among all available objects.
Definition: Selectable.cc:73
boost::noncopyable NonCopyable
Ensure derived classes cannot be copied.
Definition: NonCopyable.h:26
bool hasInstalledObjOnly() const
True if installed object is present but no candidate.
Definition: Selectable.h:317
bool setInstalled(ResStatus::TransactByValue causer_r=ResStatus::USER)
Take care the item gets installed if it is not.
Definition: Selectable.cc:278
ResTraits< TRes >::constPtrType candidateAsKind() const
Return the candidateObj resolvable casted to a specific kind.
Definition: Selectable.h:209
bool identicalInstalledCandidate() const
True if the candidateObj is installed (same content).
Definition: Selectable.h:171
bool isSatisfied() const
Whether a relevant patchs requirements are met.
Definition: Selectable.cc:201
bool setToDelete(ResStatus::TransactByValue causer_r=ResStatus::USER)
Set the item to be deleted (must be installed).
Definition: Selectable.h:479
Iterable< available_iterator > available() const
Definition: Selectable.h:249
std::ostream & operator<<(std::ostream &str, const Selectable &obj)
Definition: Selectable.cc:306
bool isUndetermined() const
Returns true for packages, because packages are not classified by the solver.
Definition: Selectable.cc:195
std::ostream & dumpOn(std::ostream &str, const Selectable &obj)
Definition: Selectable.cc:309
PoolItem theObj() const
An object you could use as pars pro toto.
Definition: Selectable.cc:113
bool identicalAvailable(const PoolItem &rhs) const
True if rhs is installed and one with the same content is available.
Definition: Selectable.cc:88
friend std::ostream & operator<<(std::ostream &str, const Selectable &obj)
Definition: Selectable.cc:306
bool setDeleted(ResStatus::TransactByValue causer_r=ResStatus::USER)
Take care the item gets deleted if it is installed.
Definition: Selectable.cc:296
picklist_iterator picklistBegin() const
Definition: Selectable.cc:152
PoolItem highestAvailableVersionObj() const
Simply the highest available version, ignoring priorities and policies.
Definition: Selectable.cc:82
shared_ptr< Impl > Impl_Ptr
Definition: Selectable.h:519
Base class for reference counted objects.
SelectableTraits::available_iterator available_iterator
Iterates over ResObject::constPtr.
Definition: Selectable.h:61
bool hasCandidateObjOnly() const
True if candidate object is present but no installed.
Definition: Selectable.h:321
ResKind kind() const
The ResObjects kind.
Definition: Selectable.cc:58
bool setPickStatus(const PoolItem &pi_r, Status state_r, ResStatus::TransactByValue causer_r=ResStatus::USER)
Assign a new status to a specific item.
Definition: Selectable.cc:190
bool identIsAutoInstalled() const
Whether this ident is flagged as AutoInstalled.
Definition: Selectable.cc:85
bool identicalInstalled(const PoolItem &rhs) const
True if rhs has the same content as an installed one.
Definition: Selectable.cc:91
intrusive_ptr< const Selectable > constPtr
Definition: Selectable.h:58
installed_size_type installedSize() const
Definition: Selectable.cc:135
bool isNeeded() const
This includes unlocked broken patches, as well as those already selected to be installed.
Definition: Selectable.cc:207
available_iterator availableBegin() const
Definition: Selectable.cc:124
picklist_iterator picklistEnd() const
Definition: Selectable.cc:155
available_size_type availableSize() const
Definition: Selectable.cc:121
Status pickStatus(const PoolItem &pi_r) const
Compute the ui::Status for an individual PoolItem.
Definition: Selectable.cc:187
Selectable implementation.
ResTraits< TRes >::constPtrType installedAsKind() const
Return the installedObj resolvable casted to a specific kind.
Definition: Selectable.h:199
PickList::size_type picklist_size_type
Status status() const
Return the current Status.
Definition: Selectable.cc:64
bool hasBothObjects() const
True if installed and candidate object is present.
Definition: Selectable.h:313
bool isUnwanted() const
Broken (needed) but locked patches.
Definition: Selectable.cc:212
bool unset(ResStatus::TransactByValue causer_r=ResStatus::USER)
Set the item to stay unmodified.
Definition: Selectable.h:486
bool multiversionInstall() const
Whether at least one of the available packages has multiversionInstall set.
Definition: Selectable.cc:178
DEFINE_PTR_TYPE(Selectable)
AvailableItemSet::iterator installed_iterator
bool pickInstall(const PoolItem &pi_r, ResStatus::TransactByValue causer_r=ResStatus::USER, bool yesno_r=true)
Select a specific available item for installation.
Definition: Selectable.cc:181
bool hasObject() const
True if either installed or candidate object is present.
Definition: Selectable.h:301
Selectable(Impl_Ptr pimpl_r)
Default ctor.
Definition: Selectable.cc:36
Iterable< picklist_iterator > picklist() const
Definition: Selectable.h:278
bool setUpToDate(ResStatus::TransactByValue causer_r=ResStatus::USER)
Take care the item gets installed if it is not, or is older.
Definition: Selectable.cc:283
AvailableItemSet::size_type installed_size_type
Selectable_Ptr operator()(const PoolItem &pi_r) const
Definition: Selectable.h:548
SelectableTraits::picklist_iterator picklist_iterator
Definition: Selectable.h:67
Selectable_Ptr result_type
Definition: Selectable.h:544
bool picklistEmpty() const
Definition: Selectable.cc:146
bool toDelete() const
True if to delete.
Definition: Selectable.h:449
Combining sat::Solvable and ResStatus.
Definition: PoolItem.h:50
bool setFate(Fate fate_r, ResStatus::TransactByValue causer_r=ResStatus::USER)
Definition: Selectable.cc:251
installed_iterator installedEnd() const
Definition: Selectable.cc:141
bool hasLicenceConfirmed() const
Return value of LicenceConfirmed bit.
Definition: Selectable.cc:220
Resolvable kinds.
Definition: ResKind.h:32
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:1
bool availableEmpty() const
Definition: Selectable.cc:118
PoolItem candidateObjFrom(Repository repo_r) const
The best candidate provided by a specific Repository, if there is one.
Definition: Selectable.cc:76
SelectableTraits::picklist_size_type picklist_size_type
Definition: Selectable.h:68
friend std::ostream & dumpOn(std::ostream &str, const Selectable &obj)
Definition: Selectable.cc:309
bool pickNoDelete(const PoolItem &pi_r, ResStatus::TransactByValue causer_r=ResStatus::USER)
Deselect a specific installed item from deletion.
Definition: Selectable.h:359
Solvable to Selectable transform functor.
Definition: Selectable.h:542
bool pickDelete(const PoolItem &pi_r, ResStatus::TransactByValue causer_r=ResStatus::USER, bool yesno_r=true)
Select a specific installed item for deletion.
Definition: Selectable.cc:184
Solvable satSolvable() const
Return the corresponding sat::Solvable.
Definition: SolvableType.h:57
PoolItem installedObj() const
The last Installed object.
Definition: Selectable.cc:70
installed_iterator installedBegin() const
Definition: Selectable.cc:138
bool hasInstalledObj() const
True if installed object is present.
Definition: Selectable.h:305
SelectableTraits::installed_size_type installed_size_type
Definition: Selectable.h:65
Main filter selecting PoolItems by name and kind.
Definition: ByIdent.h:26
RW_pointer< Impl > _pimpl
Pointer to implementation.
Definition: Selectable.h:528
AvailableItemSet::size_type available_size_type
AvailableItemSet::iterator available_iterator
SelectableTraits::available_size_type available_size_type
Definition: Selectable.h:62
bool isRelevant() const
Returns true if the patch is relevant which means that at least one package of the patch is installed...
Definition: Selectable.cc:198
picklist_size_type picklistSize() const
Definition: Selectable.cc:149
bool isUnmaintained() const
True if this package has no replacement from the available repositories.
Definition: Selectable.cc:175
const std::string & name() const
The ResObjects name.
Definition: Selectable.cc:61