libzypp  17.10.3
Solvable.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_SAT_SOLVABLE_H
13 #define ZYPP_SAT_SOLVABLE_H
14 
15 #include <iosfwd>
16 
18 #include "zypp/sat/SolvAttr.h"
19 #include "zypp/ResTraits.h"
20 #include "zypp/IdString.h"
21 #include "zypp/Edition.h"
22 #include "zypp/Arch.h"
23 #include "zypp/Dep.h"
24 #include "zypp/Capabilities.h"
25 #include "zypp/Capability.h"
26 #include "zypp/Locale.h"
27 
29 namespace zypp
30 {
31  class ByteCount;
32  class CheckSum;
33  class CpeId;
34  class Date;
35  class OnMediaLocation;
37  namespace sat
38  {
53  class Solvable : protected detail::PoolMember
54  {
55  public:
57 
58  public:
61  : _id( detail::noSolvableId )
62  {}
63 
65  explicit Solvable( IdType id_r )
66  : _id( id_r )
67  {}
68 
69  public:
71  static const Solvable noSolvable;
72 
74  explicit operator bool() const
75  { return get(); }
76 
77  public:
82  IdString ident()const;
83 
85  ResKind kind()const;
86 
91  bool isKind( const ResKind & kind_r ) const;
93  template<class TRes>
94  bool isKind() const
95  { return isKind( resKind<TRes>() ); }
97  template<class TIterator>
98  bool isKind( TIterator begin, TIterator end ) const
99  { for_( it, begin, end ) if ( isKind( *it ) ) return true; return false; }
100 
102  std::string name() const;
103 
105  Edition edition() const;
106 
108  Arch arch() const;
109 
111  IdString vendor() const;
112 
114  Repository repository() const;
116  RepoInfo repoInfo() const;
117 
121  bool isSystem() const;
122 
126  bool onSystemByUser() const;
127 
131  bool onSystemByAuto() const;
132 
134  bool identIsAutoInstalled() const
135  { return identIsAutoInstalled( ident() ); }
137  static bool identIsAutoInstalled( const IdString & ident_r );
138 
140  bool isNeedreboot() const;
141 
145  bool multiversionInstall() const;
146 
148  Date buildtime() const;
149 
151  Date installtime() const;
152 
153  public:
161  std::string asString() const;
162 
164  std::string asUserString() const;
165 
169  bool identical( const Solvable & rhs ) const;
170 
172  bool sameNVRA( const Solvable & rhs ) const
173  { return( get() == rhs.get() || ( ident() == rhs.ident() && edition() == rhs.edition() && arch() == rhs.arch() ) ); }
174 
175  public:
181  Capabilities provides() const;
182  Capabilities requires() const;
183  Capabilities conflicts() const;
184  Capabilities obsoletes() const;
185  Capabilities recommends() const;
186  Capabilities suggests() const;
187  Capabilities enhances() const;
188  Capabilities supplements() const;
189  Capabilities prerequires() const;
190 
192  Capabilities dep( Dep which_r ) const
193  {
194  switch( which_r.inSwitch() )
195  {
196  case Dep::PROVIDES_e: return provides(); break;
197  case Dep::REQUIRES_e: return requires(); break;
198  case Dep::CONFLICTS_e: return conflicts(); break;
199  case Dep::OBSOLETES_e: return obsoletes(); break;
200  case Dep::RECOMMENDS_e: return recommends(); break;
201  case Dep::SUGGESTS_e: return suggests(); break;
202  case Dep::ENHANCES_e: return enhances(); break;
203  case Dep::SUPPLEMENTS_e: return supplements(); break;
204  case Dep::PREREQUIRES_e: return prerequires(); break;
205  }
206  return Capabilities();
207  }
209  Capabilities operator[]( Dep which_r ) const
210  { return dep( which_r ); }
211 
212 
214  CapabilitySet providesNamespace( const std::string & namespace_r ) const;
215 
223  CapabilitySet valuesOfNamespace( const std::string & namespace_r ) const;
225 
226  public:
230  bool supportsLocales() const;
232  bool supportsLocale( const Locale & locale_r ) const;
234  bool supportsLocale( const LocaleSet & locales_r ) const;
238  bool supportsRequestedLocales() const;
242  void getSupportedLocales( LocaleSet & locales_r ) const
243  { locales_r = getSupportedLocales(); }
245 
246  public:
248  CpeId cpeId() const;
249 
251  unsigned mediaNr() const;
252 
274  ByteCount installSize() const;
275 
277  ByteCount downloadSize() const;
278 
280  std::string distribution() const;
281 
283  std::string summary( const Locale & lang_r = Locale() ) const;
284 
286  std::string description( const Locale & lang_r = Locale() ) const;
287 
289  std::string insnotify( const Locale & lang_r = Locale() ) const;
291  std::string delnotify( const Locale & lang_r = Locale() ) const;
292 
294  std::string licenseToConfirm( const Locale & lang_r = Locale() ) const;
296  bool needToAcceptLicense() const;
297 
298  public:
305  {
306  public:
308  SplitIdent( IdString ident_r );
309  SplitIdent( const char * ident_r );
310  SplitIdent( const std::string & ident_r );
311  SplitIdent( ResKind kind_r, IdString name_r );
312  SplitIdent( ResKind kind_r, const C_Str & name_r );
313 
314  IdString ident() const { return _ident; }
315  ResKind kind() const { return _kind; }
316  IdString name() const { return _name; }
317 
318  private:
322  };
323 
324  public:
334  std::string lookupStrAttribute( const SolvAttr & attr ) const;
345  std::string lookupStrAttribute( const SolvAttr & attr, const Locale & lang_r ) const;
346 
351  unsigned long long lookupNumAttribute( const SolvAttr & attr ) const;
353  unsigned long long lookupNumAttribute( const SolvAttr & attr, unsigned long long notfound_r ) const;
354 
359  bool lookupBoolAttribute( const SolvAttr & attr ) const;
360 
366 
372 
379 
380  public:
382  Solvable nextInPool() const;
384  Solvable nextInRepo() const;
386  detail::CSolvable * get() const;
388  IdType id() const { return _id; }
389 
390  private:
392  };
394 
396  std::ostream & operator<<( std::ostream & str, const Solvable & obj );
397 
399  std::ostream & dumpOn( std::ostream & str, const Solvable & obj );
400 
402  std::ostream & dumpAsXmlOn( std::ostream & str, const Solvable & obj );
403 
405  inline bool operator==( const Solvable & lhs, const Solvable & rhs )
406  { return lhs.get() == rhs.get(); }
407 
409  inline bool operator!=( const Solvable & lhs, const Solvable & rhs )
410  { return lhs.get() != rhs.get(); }
411 
413  inline bool operator<( const Solvable & lhs, const Solvable & rhs )
414  { return lhs.get() < rhs.get(); }
415 
417  template<class TRes>
418  inline bool isKind( const Solvable & solvable_r )
419  { return solvable_r.isKind( ResTraits<TRes>::kind ); }
420 
422  inline bool identical( const Solvable & lhs, const Solvable & rhs )
423  { return lhs.identical( rhs ); }
424 
426  inline bool sameNVRA( const Solvable & lhs, const Solvable & rhs )
427  { return lhs.sameNVRA( rhs ); }
428 
429 
431  inline int compareByN( const Solvable & lhs, const Solvable & rhs )
432  {
433  int res = 0;
434  if ( lhs != rhs )
435  {
436  if ( (res = lhs.kind().compare( rhs.kind() )) == 0 )
437  res = lhs.name().compare( rhs.name() );
438  }
439  return res;
440  }
441 
443  inline int compareByNVR( const Solvable & lhs, const Solvable & rhs )
444  {
445  int res = compareByN( lhs, rhs );
446  if ( res == 0 )
447  res = lhs.edition().compare( rhs.edition() );
448  return res;
449  }
450 
452  inline int compareByNVRA( const Solvable & lhs, const Solvable & rhs )
453  {
454  int res = compareByNVR( lhs, rhs );
455  if ( res == 0 )
456  res = lhs.arch().compare( rhs.arch() );
457  return res;
458  }
459 
461  namespace detail
462  {
464  //
465  // CLASS NAME : SolvableIterator
466  //
468  class SolvableIterator : public boost::iterator_adaptor<
469  SolvableIterator // Derived
470  , CSolvable* // Base
471  , const Solvable // Value
472  , boost::forward_traversal_tag // CategoryOrTraversal
473  , const Solvable // Reference
474  >
475  {
476  public:
478  : SolvableIterator::iterator_adaptor_( 0 )
479  {}
480 
481  explicit SolvableIterator( const Solvable & val_r )
482  : SolvableIterator::iterator_adaptor_( 0 )
483  { assignVal( val_r ); }
484 
486  : SolvableIterator::iterator_adaptor_( 0 )
487  { assignVal( Solvable( id_r ) ); }
488 
489  private:
491 
493  { return _val; }
494 
495  void increment()
496  { assignVal( _val.nextInPool() ); }
497 
498  private:
499  void assignVal( const Solvable & val_r )
500  { _val = val_r; base_reference() = _val.get(); }
501 
503  };
504  } // namespace detail
506  } // namespace sat
508 
509  class PoolItem;
511  namespace sat
512  {
517  struct asSolvable
518  {
520 
521  Solvable operator()( const Solvable & solv_r ) const
522  { return solv_r; }
523 
524  Solvable operator()( const PoolItem & pi_r ) const;
525 
526  Solvable operator()( const ResObject_constPtr & res_r ) const;
527  };
528  } // namespace sat
530 } // namespace zypp
532 
534 
535 #endif // ZYPP_SAT_SOLVABLE_H
static const SolvableIdType noSolvableId(0)
Id to denote Solvable::noSolvable.
bool sameNVRA(const Solvable &rhs) const
Test for same name-version-release.arch.
Definition: Solvable.h:172
std::string description(const Locale &lang_r=Locale()) const
Long (multiline) text describing the solvable (opt.
Definition: Solvable.cc:681
std::string name() const
The name (without any ResKind prefix).
Definition: Solvable.cc:325
int IdType
Generic Id type.
Definition: PoolMember.h:104
A Solvable object within the sat Pool.
Definition: Solvable.h:53
IdString vendor() const
The vendor.
Definition: Solvable.cc:353
IdType id() const
Expert backdoor.
Definition: Solvable.h:388
Capabilities provides() const
Definition: Solvable.cc:450
RepoInfo repoInfo() const
The repositories RepoInfo.
Definition: Solvable.cc:365
ResKind kind() const
The Solvables ResKind.
Definition: Solvable.cc:271
Container of Capability (currently read only).
Definition: Capabilities.h:35
Describes a path on a certain media amongs as the information required to download it...
SolvableIterator(const Solvable &val_r)
Definition: Solvable.h:481
Enumeration class of dependency types.
Definition: Dep.h:29
bool isKind(TIterator begin, TIterator end) const
Definition: Solvable.h:98
OnMediaLocation lookupLocation() const
returns OnMediaLocation data: This is everything we need to download e.g.
Definition: Solvable.cc:220
bool isKind(const Solvable &solvable_r)
Definition: Solvable.h:418
Architecture.
Definition: Arch.h:36
LocaleSet getSupportedLocales() const
Return the supported locales.
Definition: Solvable.cc:631
Capabilities recommends() const
Definition: Solvable.cc:470
Store and operate with byte count.
Definition: ByteCount.h:30
detail::IdType lookupIdAttribute(const SolvAttr &attr) const
returns the id attribute value for attr or detail::noId if it does not exists.
Definition: Solvable.cc:172
sat::SolvAttr attr
Definition: PoolQuery.cc:311
std::ostream & operator<<(std::ostream &str, const FileConflicts &obj)
bool operator==(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:405
ZYPP_DEFINE_ID_HASHABLE(::zypp::sat::Solvable)
String related utilities and Regular expression matching.
Capabilities supplements() const
Definition: Solvable.cc:485
unsigned SolvableIdType
Id type to connect Solvable and sat-solvable.
Definition: PoolMember.h:125
bool isKind(const ResKind &kind_r) const
Test whether a Solvable is of a certain ResKind.
Definition: Solvable.cc:298
What is known about a repository.
Definition: RepoInfo.h:71
std::string delnotify(const Locale &lang_r=Locale()) const
UI hint text when selecting the solvable for uninstall (opt.
Definition: Solvable.cc:693
Access to the sat-pools string space.
Definition: IdString.h:41
Common Platform Enumearation (2.3) See http://cpe.mitre.org/ for more information on the Common Platf...
Definition: CpeId.h:31
#define for_(IT, BEG, END)
Convenient for-loops using iterator.
Definition: Easy.h:27
Edition represents [epoch:]version[-release]
Definition: Edition.h:60
ResTraits.
Definition: ResTraits.h:79
ByteCount downloadSize() const
Download size.
Definition: Solvable.cc:663
int compare(const Arch &rhs) const
Arch comparison.
Definition: Arch.cc:542
bool identical(const Solvable &rhs) const
Test whether two Solvables have the same content.
Definition: Solvable.cc:433
bool compareByN(const SolvableType< Derived > &lhs, const Solvable &rhs)
Definition: SolvableType.h:242
static const Solvable noSolvable
Represents no Solvable.
Definition: Solvable.h:71
int compareByNVRA(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:452
bool identical(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:422
CapabilitySet valuesOfNamespace(const std::string &namespace_r) const
Return &#39;value[ op edition]&#39; for namespaced provides &#39;namespace(value)[ op edition]&#39;.
Definition: Solvable.cc:513
Solvable nextInRepo() const
Return next Solvable in Repo (or noSolvable).
Definition: Solvable.cc:112
std::string asUserString() const
String representation "ident-edition.arch(repo)" or "noSolvable".
Definition: Solvable.cc:423
bool sameNVRA(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:426
static int compare(const Derived &lhs, const Derived &rhs)
Definition: IdStringType.h:127
std::string distribution() const
The distribution string.
Definition: Solvable.cc:669
Repository repository() const
The Repository this Solvable belongs to.
Definition: Solvable.cc:359
bool onSystemByAuto() const
Whether this is known to be automatically installed (as dependency of a user request package)...
Definition: Solvable.cc:380
bool isKind() const
Definition: Solvable.h:94
Store and operate on date (time_t).
Definition: Date.h:32
bool identIsAutoInstalled() const
Whether an installed solvable with the same ident is flagged as AutoInstalled.
Definition: Solvable.h:134
Solvable attribute keys.
Definition: SolvAttr.h:40
Backlink to the associated PoolImpl.
Definition: PoolMember.h:88
for_use_in_switch inSwitch() const
Enumarator provided for use in switch statement.
Definition: Dep.h:89
Capabilities enhances() const
Definition: Solvable.cc:480
Edition edition() const
The edition (version-release).
Definition: Solvable.cc:333
CapabilitySet providesNamespace(const std::string &namespace_r) const
Return the namespaced provides &#39;namespace([value])[ op edition]&#39; of this Solvable.
Definition: Solvable.cc:499
Convenience char* constructible from std::string and char*, it maps (char*)0 to an empty string...
Definition: String.h:90
ByteCount installSize() const
Installed (unpacked) size.
Definition: Solvable.cc:657
unsigned long long lookupNumAttribute(const SolvAttr &attr) const
returns the numeric attribute value for attr or 0 if it does not exists.
Definition: Solvable.cc:154
int compareByNVR(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:443
CheckSum lookupCheckSumAttribute(const SolvAttr &attr) const
returns the CheckSum attribute value for attr or an empty CheckSum if ir does not exist...
Definition: Solvable.cc:178
Arch arch() const
The architecture.
Definition: Solvable.cc:339
void getSupportedLocales(LocaleSet &locales_r) const
Definition: Solvable.h:242
Capabilities operator[](Dep which_r) const
Definition: Solvable.h:209
unsigned mediaNr() const
Media number the solvable is located on (0 if no media access required).
Definition: Solvable.cc:644
std::string asString() const
String representation "ident-edition.arch" or "noSolvable".
Definition: Solvable.cc:414
Solvable(IdType id_r)
PoolImpl ctor.
Definition: Solvable.h:65
CpeId cpeId() const
The solvables CpeId if available.
Definition: Solvable.cc:638
bool multiversionInstall() const
Whether different versions of this package can be installed at the same time.
Definition: Solvable.cc:396
void assignVal(const Solvable &val_r)
Definition: Solvable.h:499
Capabilities requires() const
Definition: Solvable.cc:455
std::ostream & dumpOn(std::ostream &str, const LocaleSupport &obj)
::s_Solvable CSolvable
Wrapped libsolv C data type exposed as backdoor.
Definition: PoolMember.h:64
bool isSystem() const
Return whether this Solvable belongs to the system repo.
Definition: Solvable.cc:369
Solvable nextInPool() const
Return next Solvable in Pool (or noSolvable).
Definition: Solvable.cc:109
&#39;Language[_Country]&#39; codes.
Definition: Locale.h:49
bool supportsLocale(const Locale &locale_r) const
Whether this Solvable supports a specific Locale.
Definition: Solvable.cc:614
detail::CSolvable * get() const
Expert backdoor.
Definition: Solvable.cc:102
friend class boost::iterator_core_access
Definition: Solvable.h:490
bool compareByNVR(const SolvableType< Derived > &lhs, const Solvable &rhs)
Definition: SolvableType.h:256
std::string lookupStrAttribute(const SolvAttr &attr) const
returns the string attribute value for attr or an empty string if it does not exists.
Definition: Solvable.cc:126
std::unordered_set< Capability > CapabilitySet
Definition: Capability.h:33
Solvable()
Default ctor creates noSolvable.
Definition: Solvable.h:60
bool supportsRequestedLocales() const
Whether this Solvable supports at least one requested locale.
Definition: Solvable.cc:628
bool isNeedreboot() const
Whether this solvable triggers the reboot-needed hint if installed/updated.
Definition: Solvable.cc:390
std::string insnotify(const Locale &lang_r=Locale()) const
UI hint text when selecting the solvable for install (opt.
Definition: Solvable.cc:687
std::string summary(const Locale &lang_r=Locale()) const
Short (singleline) text describing the solvable (opt.
Definition: Solvable.cc:675
Capabilities conflicts() const
Definition: Solvable.cc:460
SolvableIterator(SolvableIdType id_r)
Definition: Solvable.h:485
bool onSystemByUser() const
Whether this is known to be installed on behalf of a user request.
Definition: Solvable.cc:375
Helper that splits an identifier into kind and name or vice versa.
Definition: Solvable.h:304
Capabilities prerequires() const
Definition: Solvable.cc:490
Capabilities dep(Dep which_r) const
Return Capabilities selected by Dep constant.
Definition: Solvable.h:192
Solvable result_type
Definition: Solvable.h:519
bool needToAcceptLicense() const
True except for well known exceptions (i.e show license but no need to accept it).
Definition: Solvable.cc:716
int compareByN(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:431
bool operator<(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:413
Solvable operator()(const Solvable &solv_r) const
Definition: Solvable.h:521
Combining sat::Solvable and ResStatus.
Definition: PoolItem.h:50
Capabilities obsoletes() const
Definition: Solvable.cc:465
std::ostream & dumpAsXmlOn(std::ostream &str, const FileConflicts &obj)
sat::detail::SolvableIdType IdType
Definition: Solvable.h:56
Resolvable kinds.
Definition: ResKind.h:32
To Solvable transform functor.
Definition: Solvable.h:517
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:1
bool supportsLocales() const
Whether this Solvable claims to support locales.
Definition: Solvable.cc:608
Date buildtime() const
The items build time.
Definition: Solvable.cc:402
std::string licenseToConfirm(const Locale &lang_r=Locale()) const
License or agreement to accept before installing the solvable (opt.
Definition: Solvable.cc:699
std::unordered_set< Locale > LocaleSet
Definition: Locale.h:27
Capabilities suggests() const
Definition: Solvable.cc:475
IdString ident() const
The identifier.
Definition: Solvable.cc:265
Date installtime() const
The items install time (false if not installed).
Definition: Solvable.cc:408
bool operator!=(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:409
bool lookupBoolAttribute(const SolvAttr &attr) const
returns the boolean attribute value for attr or false if it does not exists.
Definition: Solvable.cc:166