libzypp  17.3.0
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 
142  bool multiversionInstall() const;
143 
145  Date buildtime() const;
146 
148  Date installtime() const;
149 
150  public:
158  std::string asString() const;
159 
161  std::string asUserString() const;
162 
166  bool identical( const Solvable & rhs ) const;
167 
169  bool sameNVRA( const Solvable & rhs ) const
170  { return( get() == rhs.get() || ( ident() == rhs.ident() && edition() == rhs.edition() && arch() == rhs.arch() ) ); }
171 
172  public:
178  Capabilities provides() const;
179  Capabilities requires() const;
180  Capabilities conflicts() const;
181  Capabilities obsoletes() const;
182  Capabilities recommends() const;
183  Capabilities suggests() const;
184  Capabilities enhances() const;
185  Capabilities supplements() const;
186  Capabilities prerequires() const;
187 
189  Capabilities dep( Dep which_r ) const
190  {
191  switch( which_r.inSwitch() )
192  {
193  case Dep::PROVIDES_e: return provides(); break;
194  case Dep::REQUIRES_e: return requires(); break;
195  case Dep::CONFLICTS_e: return conflicts(); break;
196  case Dep::OBSOLETES_e: return obsoletes(); break;
197  case Dep::RECOMMENDS_e: return recommends(); break;
198  case Dep::SUGGESTS_e: return suggests(); break;
199  case Dep::ENHANCES_e: return enhances(); break;
200  case Dep::SUPPLEMENTS_e: return supplements(); break;
201  case Dep::PREREQUIRES_e: return prerequires(); break;
202  }
203  return Capabilities();
204  }
206  Capabilities operator[]( Dep which_r ) const
207  { return dep( which_r ); }
208 
209 
211  CapabilitySet providesNamespace( const std::string & namespace_r ) const;
212 
220  CapabilitySet valuesOfNamespace( const std::string & namespace_r ) const;
222 
223  public:
227  bool supportsLocales() const;
229  bool supportsLocale( const Locale & locale_r ) const;
231  bool supportsLocale( const LocaleSet & locales_r ) const;
235  bool supportsRequestedLocales() const;
239  void getSupportedLocales( LocaleSet & locales_r ) const
240  { locales_r = getSupportedLocales(); }
242 
243  public:
245  CpeId cpeId() const;
246 
248  unsigned mediaNr() const;
249 
271  ByteCount installSize() const;
272 
274  ByteCount downloadSize() const;
275 
277  std::string distribution() const;
278 
280  std::string summary( const Locale & lang_r = Locale() ) const;
281 
283  std::string description( const Locale & lang_r = Locale() ) const;
284 
286  std::string insnotify( const Locale & lang_r = Locale() ) const;
288  std::string delnotify( const Locale & lang_r = Locale() ) const;
289 
291  std::string licenseToConfirm( const Locale & lang_r = Locale() ) const;
293  bool needToAcceptLicense() const;
294 
295  public:
302  {
303  public:
305  SplitIdent( IdString ident_r );
306  SplitIdent( const char * ident_r );
307  SplitIdent( const std::string & ident_r );
308  SplitIdent( ResKind kind_r, IdString name_r );
309  SplitIdent( ResKind kind_r, const C_Str & name_r );
310 
311  IdString ident() const { return _ident; }
312  ResKind kind() const { return _kind; }
313  IdString name() const { return _name; }
314 
315  private:
319  };
320 
321  public:
331  std::string lookupStrAttribute( const SolvAttr & attr ) const;
342  std::string lookupStrAttribute( const SolvAttr & attr, const Locale & lang_r ) const;
343 
348  unsigned long long lookupNumAttribute( const SolvAttr & attr ) const;
350  unsigned long long lookupNumAttribute( const SolvAttr & attr, unsigned long long notfound_r ) const;
351 
356  bool lookupBoolAttribute( const SolvAttr & attr ) const;
357 
363 
369 
376 
377  public:
379  Solvable nextInPool() const;
381  Solvable nextInRepo() const;
383  detail::CSolvable * get() const;
385  IdType id() const { return _id; }
386 
387  private:
388  IdType _id;
389  };
391 
393  std::ostream & operator<<( std::ostream & str, const Solvable & obj );
394 
396  std::ostream & dumpOn( std::ostream & str, const Solvable & obj );
397 
399  std::ostream & dumpAsXmlOn( std::ostream & str, const Solvable & obj );
400 
402  inline bool operator==( const Solvable & lhs, const Solvable & rhs )
403  { return lhs.get() == rhs.get(); }
404 
406  inline bool operator!=( const Solvable & lhs, const Solvable & rhs )
407  { return lhs.get() != rhs.get(); }
408 
410  inline bool operator<( const Solvable & lhs, const Solvable & rhs )
411  { return lhs.get() < rhs.get(); }
412 
414  template<class TRes>
415  inline bool isKind( const Solvable & solvable_r )
416  { return solvable_r.isKind( ResTraits<TRes>::kind ); }
417 
419  inline bool identical( const Solvable & lhs, const Solvable & rhs )
420  { return lhs.identical( rhs ); }
421 
423  inline bool sameNVRA( const Solvable & lhs, const Solvable & rhs )
424  { return lhs.sameNVRA( rhs ); }
425 
426 
428  inline int compareByN( const Solvable & lhs, const Solvable & rhs )
429  {
430  int res = 0;
431  if ( lhs != rhs )
432  {
433  if ( (res = lhs.kind().compare( rhs.kind() )) == 0 )
434  res = lhs.name().compare( rhs.name() );
435  }
436  return res;
437  }
438 
440  inline int compareByNVR( const Solvable & lhs, const Solvable & rhs )
441  {
442  int res = compareByN( lhs, rhs );
443  if ( res == 0 )
444  res = lhs.edition().compare( rhs.edition() );
445  return res;
446  }
447 
449  inline int compareByNVRA( const Solvable & lhs, const Solvable & rhs )
450  {
451  int res = compareByNVR( lhs, rhs );
452  if ( res == 0 )
453  res = lhs.arch().compare( rhs.arch() );
454  return res;
455  }
456 
458  namespace detail
459  {
461  //
462  // CLASS NAME : SolvableIterator
463  //
465  class SolvableIterator : public boost::iterator_adaptor<
466  SolvableIterator // Derived
467  , CSolvable* // Base
468  , const Solvable // Value
469  , boost::forward_traversal_tag // CategoryOrTraversal
470  , const Solvable // Reference
471  >
472  {
473  public:
475  : SolvableIterator::iterator_adaptor_( 0 )
476  {}
477 
478  explicit SolvableIterator( const Solvable & val_r )
479  : SolvableIterator::iterator_adaptor_( 0 )
480  { assignVal( val_r ); }
481 
483  : SolvableIterator::iterator_adaptor_( 0 )
484  { assignVal( Solvable( id_r ) ); }
485 
486  private:
487  friend class boost::iterator_core_access;
488 
490  { return _val; }
491 
492  void increment()
493  { assignVal( _val.nextInPool() ); }
494 
495  private:
496  void assignVal( const Solvable & val_r )
497  { _val = val_r; base_reference() = _val.get(); }
498 
500  };
501  } // namespace detail
503  } // namespace sat
505 
506  class PoolItem;
508  namespace sat
509  {
514  struct asSolvable
515  {
517 
518  Solvable operator()( const Solvable & solv_r ) const
519  { return solv_r; }
520 
521  Solvable operator()( const PoolItem & pi_r ) const;
522 
523  Solvable operator()( const ResObject_constPtr & res_r ) const;
524  };
525  } // namespace sat
527 } // namespace zypp
529 
531 
532 #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:169
std::string description(const Locale &lang_r=Locale()) const
Long (multiline) text describing the solvable (opt.
Definition: Solvable.cc:675
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:385
Capabilities provides() const
Definition: Solvable.cc:444
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:478
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:415
Architecture.
Definition: Arch.h:36
LocaleSet getSupportedLocales() const
Return the supported locales.
Definition: Solvable.cc:625
Capabilities recommends() const
Definition: Solvable.cc:464
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
bool operator==(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:402
ZYPP_DEFINE_ID_HASHABLE(::zypp::sat::Solvable)
std::ostream & operator<<(std::ostream &str, const Solvable &obj)
Definition: Solvable.cc:726
String related utilities and Regular expression matching.
Capabilities supplements() const
Definition: Solvable.cc:479
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:687
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
::_Solvable CSolvable
Wrapped libsolv C data type exposed as backdoor.
Definition: PoolMember.h:64
ResTraits.
Definition: ResTraits.h:79
ByteCount downloadSize() const
Download size.
Definition: Solvable.cc:657
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:427
static const Solvable noSolvable
Represents no Solvable.
Definition: Solvable.h:71
int compareByNVRA(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:449
bool identical(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:419
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:507
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:417
bool sameNVRA(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:423
static int compare(const Derived &lhs, const Derived &rhs)
Definition: IdStringType.h:127
std::string distribution() const
The distribution string.
Definition: Solvable.cc:663
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:474
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:493
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:651
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:440
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:239
Capabilities operator[](Dep which_r) const
Definition: Solvable.h:206
unsigned mediaNr() const
Media number the solvable is located on (0 if no media access required).
Definition: Solvable.cc:638
std::ostream & dumpOn(std::ostream &str, const Solvable &obj)
Definition: Solvable.cc:737
std::string asString() const
String representation "ident-edition.arch" or "noSolvable".
Definition: Solvable.cc:408
Solvable(IdType id_r)
PoolImpl ctor.
Definition: Solvable.h:65
CpeId cpeId() const
The solvables CpeId if available.
Definition: Solvable.cc:632
bool multiversionInstall() const
Whether different versions of this package can be installed at the same time.
Definition: Solvable.cc:390
void assignVal(const Solvable &val_r)
Definition: Solvable.h:496
Capabilities requires() const
Definition: Solvable.cc:449
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:608
detail::CSolvable * get() const
Expert backdoor.
Definition: Solvable.cc:102
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:622
std::string insnotify(const Locale &lang_r=Locale()) const
UI hint text when selecting the solvable for install (opt.
Definition: Solvable.cc:681
std::string summary(const Locale &lang_r=Locale()) const
Short (singleline) text describing the solvable (opt.
Definition: Solvable.cc:669
Capabilities conflicts() const
Definition: Solvable.cc:454
std::ostream & dumpAsXmlOn(std::ostream &str, const Solvable &obj)
Definition: Solvable.cc:757
SolvableIterator(SolvableIdType id_r)
Definition: Solvable.h:482
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:301
Capabilities prerequires() const
Definition: Solvable.cc:484
Capabilities dep(Dep which_r) const
Return Capabilities selected by Dep constant.
Definition: Solvable.h:189
Solvable result_type
Definition: Solvable.h:516
bool needToAcceptLicense() const
True except for well known exceptions (i.e show license but no need to accept it).
Definition: Solvable.cc:710
int compareByN(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:428
bool operator<(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:410
Solvable operator()(const Solvable &solv_r) const
Definition: Solvable.h:518
Combining sat::Solvable and ResStatus.
Definition: PoolItem.h:50
Capabilities obsoletes() const
Definition: Solvable.cc:459
sat::detail::SolvableIdType IdType
Definition: Solvable.h:56
Resolvable kinds.
Definition: ResKind.h:32
To Solvable transform functor.
Definition: Solvable.h:514
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:602
Date buildtime() const
The items build time.
Definition: Solvable.cc:396
std::string licenseToConfirm(const Locale &lang_r=Locale()) const
License or agreement to accept before installing the solvable (opt.
Definition: Solvable.cc:693
std::unordered_set< Locale > LocaleSet
Definition: Locale.h:27
Capabilities suggests() const
Definition: Solvable.cc:469
IdString ident() const
The identifier.
Definition: Solvable.cc:265
Date installtime() const
The items install time (false if not installed).
Definition: Solvable.cc:402
bool operator!=(const Solvable &lhs, const Solvable &rhs)
Definition: Solvable.h:406
bool lookupBoolAttribute(const SolvAttr &attr) const
returns the boolean attribute value for attr or false if it does not exists.
Definition: Solvable.cc:166