1 /*---------------------------------------------------------------------\
3 | |__ / \ / / . \ . \ |
8 \---------------------------------------------------------------------*/
9 /** \file zypp/sat/Solvable.h
12 #ifndef ZYPP_SAT_SOLVABLE_H
13 #define ZYPP_SAT_SOLVABLE_H
17 #include "zypp/sat/detail/PoolMember.h"
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"
24 #include "zypp/Capabilities.h"
25 #include "zypp/Capability.h"
26 #include "zypp/Locale.h"
28 ///////////////////////////////////////////////////////////////////
35 class OnMediaLocation;
36 ///////////////////////////////////////////////////////////////////
39 ///////////////////////////////////////////////////////////////////
41 /// \brief A \ref Solvable object within the sat \ref Pool.
43 /// \note Unfortunately libsolv combines the objects kind and
44 /// name in a single identifier \c "pattern:kde_multimedia",
45 /// \b except for packages and source packes. They are not prefixed
46 /// by any kind string. Instead the architecture is abused to store
47 /// \c "src" and \c "nosrc" values.
49 /// \ref Solvable will hide this inconsistency by treating source
50 /// packages as an own kind of solvable and map their arch to
52 ///////////////////////////////////////////////////////////////////
53 class Solvable : protected detail::PoolMember
56 typedef sat::detail::SolvableIdType IdType;
59 /** Default ctor creates \ref noSolvable.*/
61 : _id( detail::noSolvableId )
64 /** \ref PoolImpl ctor. */
65 explicit Solvable( IdType id_r )
70 /** Represents no \ref Solvable. */
71 static const Solvable noSolvable;
73 /** Evaluate \ref Solvable in a boolean context (\c != \c noSolvable). */
74 explicit operator bool() const
79 * This is the solvables \ref name, \b except for packages and
80 * source packes, prefixed by it's \ref kind.
82 IdString ident()const;
84 /** The Solvables ResKind. */
87 /** Test whether a Solvable is of a certain \ref ResKind.
88 * The test is far cheaper than actually retrieving and
89 * comparing the \ref kind.
91 bool isKind( const ResKind & kind_r ) const;
95 { return isKind( resKind<TRes>() ); }
96 /** \overload Extend the test to a range of \ref ResKind. */
97 template<class TIterator>
98 bool isKind( TIterator begin, TIterator end ) const
99 { for_( it, begin, end ) if ( isKind( *it ) ) return true; return false; }
101 /** The name (without any ResKind prefix). */
102 std::string name() const;
104 /** The edition (version-release). */
105 Edition edition() const;
107 /** The architecture. */
111 IdString vendor() const;
113 /** The \ref Repository this \ref Solvable belongs to. */
114 Repository repository() const;
115 /** The repositories \ref RepoInfo. */
116 RepoInfo repoInfo() const;
118 /** Return whether this \ref Solvable belongs to the system repo.
119 * \note This includes the otherwise hidden systemSolvable.
121 bool isSystem() const;
123 /** Whether this is known to be installed on behalf of a user request.
124 * \note Returns \c false for non-system (uninstalled) solvables.
126 bool onSystemByUser() const;
128 /** Whether this is known to be automatically installed (as dependency of a user request package).
129 * \note Returns \c false for non-system (uninstalled) solvables.
131 bool onSystemByAuto() const;
133 /** Whether an installed solvable with the same ident is flagged as AutoInstalled. */
134 bool identIsAutoInstalled() const;
136 /** Whether different versions of this package can be installed at the same time.
137 * Per default \c false. \see also \ref ZConfig::multiversion.
139 bool multiversionInstall() const;
141 /** The items build time. */
142 Date buildtime() const;
144 /** The items install time (\c false if not installed). */
145 Date installtime() const;
148 /** String representation <tt>"ident-edition.arch"</tt> or \c "noSolvable"
150 * product:openSUSE-11.1.x86_64
151 * autoyast2-2.16.19-0.1.src
155 std::string asString() const;
157 /** String representation <tt>"ident-edition.arch(repo)"</tt> or \c "noSolvable" */
158 std::string asUserString() const;
160 /** Test whether two Solvables have the same content.
161 * Basically the same name, edition, arch, vendor and buildtime.
163 bool identical( const Solvable & rhs ) const;
165 /** Test for same name-version-release.arch */
166 bool sameNVRA( const Solvable & rhs ) const
167 { return( get() == rhs.get() || ( ident() == rhs.ident() && edition() == rhs.edition() && arch() == rhs.arch() ) ); }
170 /** \name Access to the \ref Solvable dependencies.
172 * \note Prerequires are a subset of requires.
175 Capabilities provides() const;
176 Capabilities requires() const;
177 Capabilities conflicts() const;
178 Capabilities obsoletes() const;
179 Capabilities recommends() const;
180 Capabilities suggests() const;
181 Capabilities enhances() const;
182 Capabilities supplements() const;
183 Capabilities prerequires() const;
185 /** Return \ref Capabilities selected by \ref Dep constant. */
186 Capabilities dep( Dep which_r ) const
188 switch( which_r.inSwitch() )
190 case Dep::PROVIDES_e: return provides(); break;
191 case Dep::REQUIRES_e: return requires(); break;
192 case Dep::CONFLICTS_e: return conflicts(); break;
193 case Dep::OBSOLETES_e: return obsoletes(); break;
194 case Dep::RECOMMENDS_e: return recommends(); break;
195 case Dep::SUGGESTS_e: return suggests(); break;
196 case Dep::ENHANCES_e: return enhances(); break;
197 case Dep::SUPPLEMENTS_e: return supplements(); break;
198 case Dep::PREREQUIRES_e: return prerequires(); break;
200 return Capabilities();
202 /** \overload operator[] */
203 Capabilities operator[]( Dep which_r ) const
204 { return dep( which_r ); }
207 /** Return the namespaced provides <tt>'namespace([value])[ op edition]'</tt> of this Solvable. */
208 CapabilitySet providesNamespace( const std::string & namespace_r ) const;
210 /** Return <tt>'value[ op edition]'</tt> for namespaced provides <tt>'namespace(value)[ op edition]'</tt>.
211 * Similar to \ref providesNamespace, but the namespace is stripped from the
212 * dependencies. This is convenient if the namespace denotes packages that
213 * should be looked up. E.g. the \c weakremover namespace used in a products
214 * release package denotes the packages that were dropped from the distribution.
215 * \see \ref Product::droplist
217 CapabilitySet valuesOfNamespace( const std::string & namespace_r ) const;
221 /** \name Locale support. */
223 /** Whether this \c Solvable claims to support locales. */
224 bool supportsLocales() const;
225 /** Whether this \c Solvable supports a specific \ref Locale. */
226 bool supportsLocale( const Locale & locale_r ) const;
227 /** Whether this \c Solvable supports at least one of the specified locales. */
228 bool supportsLocale( const LocaleSet & locales_r ) const;
229 /** Whether this \c Solvable supports at least one requested locale.
230 * \see \ref Pool::setRequestedLocales
232 bool supportsRequestedLocales() const;
233 /** Return the supported locales. */
234 LocaleSet getSupportedLocales() const;
235 /** \overload Legacy return via arg \a locales_r */
236 void getSupportedLocales( LocaleSet & locales_r ) const
237 { locales_r = getSupportedLocales(); }
241 /** The solvables CpeId if available. */
244 /** Media number the solvable is located on (\c 0 if no media access required). */
245 unsigned mediaNr() const;
247 /** Installed (unpacked) size.
248 * This is just a total number. Many objects provide even more detailed
249 * disk usage data. You can use \ref DiskUsageCounter to find out
250 * how objects data are distributed across partitions/directories.
252 * // Load directory set into ducounter
253 * DiskUsageCounter ducounter( { "/", "/usr", "/var" } );
255 * // see how noch space the packages use
256 * for ( const PoolItem & pi : pool )
258 * cout << pi << ducounter.disk_usage( pi ) << endl;
259 * // I__s_(7)GeoIP-1.4.8-3.1.2.x86_64(@System) {
260 * // dir:[/] [ bs: 0 B ts: 0 B us: 0 B (+-: 1.0 KiB)]
261 * // dir:[/usr] [ bs: 0 B ts: 0 B us: 0 B (+-: 133.0 KiB)]
262 * // dir:[/var] [ bs: 0 B ts: 0 B us: 0 B (+-: 1.1 MiB)]
266 * \see \ref DiskUsageCounter
268 ByteCount installSize() const;
270 /** Download size. */
271 ByteCount downloadSize() const;
273 /** The distribution string. */
274 std::string distribution() const;
276 /** Short (singleline) text describing the solvable (opt. translated). */
277 std::string summary( const Locale & lang_r = Locale() ) const;
279 /** Long (multiline) text describing the solvable (opt. translated). */
280 std::string description( const Locale & lang_r = Locale() ) const;
282 /** UI hint text when selecting the solvable for install (opt. translated). */
283 std::string insnotify( const Locale & lang_r = Locale() ) const;
284 /** UI hint text when selecting the solvable for uninstall (opt. translated).*/
285 std::string delnotify( const Locale & lang_r = Locale() ) const;
287 /** License or agreement to accept before installing the solvable (opt. translated). */
288 std::string licenseToConfirm( const Locale & lang_r = Locale() ) const;
289 /** \c True except for well known exceptions (i.e show license but no need to accept it). */
290 bool needToAcceptLicense() const;
293 /** Helper that splits an identifier into kind and name or vice versa.
294 * \note In case \c name_r is preceded by a well known kind spec, the
295 * \c kind_r argument is ignored, and kind is derived from name.
302 SplitIdent( IdString ident_r );
303 SplitIdent( const char * ident_r );
304 SplitIdent( const std::string & ident_r );
305 SplitIdent( ResKind kind_r, IdString name_r );
306 SplitIdent( ResKind kind_r, const C_Str & name_r );
308 IdString ident() const { return _ident; }
309 ResKind kind() const { return _kind; }
310 IdString name() const { return _name; }
319 /** \name Attribute lookup.
320 * \see \ref LookupAttr and \ref ArrayAttr providing a general, more
321 * query like interface for attribute retrieval.
325 * returns the string attribute value for \ref attr
326 * or an empty string if it does not exists.
328 std::string lookupStrAttribute( const SolvAttr & attr ) const;
329 /** \overload Trying to look up a translated string attribute.
331 * Returns the translation for \c lang_r.
333 * Passing an empty \ref Locale will return the string for the
334 * current default locale (\see \ref ZConfig::TextLocale),
335 * \b considering all fallback locales.
337 * Returns an empty string if no translation is available.
339 std::string lookupStrAttribute( const SolvAttr & attr, const Locale & lang_r ) const;
342 * returns the numeric attribute value for \ref attr
343 * or 0 if it does not exists.
345 unsigned long long lookupNumAttribute( const SolvAttr & attr ) const;
346 /** \overload returning custom notfound_r value */
347 unsigned long long lookupNumAttribute( const SolvAttr & attr, unsigned long long notfound_r ) const;
350 * returns the boolean attribute value for \ref attr
351 * or \c false if it does not exists.
353 bool lookupBoolAttribute( const SolvAttr & attr ) const;
356 * returns the id attribute value for \ref attr
357 * or \ref detail::noId if it does not exists.
359 detail::IdType lookupIdAttribute( const SolvAttr & attr ) const;
362 * returns the CheckSum attribute value for \ref attr
363 * or an empty CheckSum if ir does not exist.
365 CheckSum lookupCheckSumAttribute( const SolvAttr & attr ) const;
368 * returns OnMediaLocation data: This is everything we need to
369 * download e.g. an rpm (path, checksum, downloadsize, etc.).
371 OnMediaLocation lookupLocation() const;
375 /** Return next Solvable in \ref Pool (or \ref noSolvable). */
376 Solvable nextInPool() const;
377 /** Return next Solvable in \ref Repo (or \ref noSolvable). */
378 Solvable nextInRepo() const;
379 /** Expert backdoor. */
380 detail::CSolvable * get() const;
381 /** Expert backdoor. */
382 IdType id() const { return _id; }
387 ///////////////////////////////////////////////////////////////////
389 /** \relates Solvable Stream output */
390 std::ostream & operator<<( std::ostream & str, const Solvable & obj );
392 /** \relates Solvable More verbose stream output including dependencies */
393 std::ostream & dumpOn( std::ostream & str, const Solvable & obj );
395 /** \relates Solvable XML output */
396 std::ostream & dumpAsXmlOn( std::ostream & str, const Solvable & obj );
398 /** \relates Solvable */
399 inline bool operator==( const Solvable & lhs, const Solvable & rhs )
400 { return lhs.get() == rhs.get(); }
402 /** \relates Solvable */
403 inline bool operator!=( const Solvable & lhs, const Solvable & rhs )
404 { return lhs.get() != rhs.get(); }
406 /** \relates Solvable */
407 inline bool operator<( const Solvable & lhs, const Solvable & rhs )
408 { return lhs.get() < rhs.get(); }
410 /** \relates Solvable Test whether a \ref Solvable is of a certain Kind. */
412 inline bool isKind( const Solvable & solvable_r )
413 { return solvable_r.isKind( ResTraits<TRes>::kind ); }
415 /** \relates Solvable Test for same content. */
416 inline bool identical( const Solvable & lhs, const Solvable & rhs )
417 { return lhs.identical( rhs ); }
419 /** \relates Solvable Test for same name version release and arch. */
420 inline bool sameNVRA( const Solvable & lhs, const Solvable & rhs )
421 { return lhs.sameNVRA( rhs ); }
424 /** \relates Solvable Compare according to \a kind and \a name. */
425 inline int compareByN( const Solvable & lhs, const Solvable & rhs )
430 if ( (res = lhs.kind().compare( rhs.kind() )) == 0 )
431 res = lhs.name().compare( rhs.name() );
436 /** \relates Solvable Compare according to \a kind, \a name and \a edition. */
437 inline int compareByNVR( const Solvable & lhs, const Solvable & rhs )
439 int res = compareByN( lhs, rhs );
441 res = lhs.edition().compare( rhs.edition() );
445 /** \relates Solvable Compare according to \a kind, \a name, \a edition and \a arch. */
446 inline int compareByNVRA( const Solvable & lhs, const Solvable & rhs )
448 int res = compareByNVR( lhs, rhs );
450 res = lhs.arch().compare( rhs.arch() );
454 ///////////////////////////////////////////////////////////////////
457 ///////////////////////////////////////////////////////////////////
459 // CLASS NAME : SolvableIterator
462 class SolvableIterator : public boost::iterator_adaptor<
463 SolvableIterator // Derived
465 , const Solvable // Value
466 , boost::forward_traversal_tag // CategoryOrTraversal
467 , const Solvable // Reference
472 : SolvableIterator::iterator_adaptor_( 0 )
475 explicit SolvableIterator( const Solvable & val_r )
476 : SolvableIterator::iterator_adaptor_( 0 )
477 { assignVal( val_r ); }
479 explicit SolvableIterator( SolvableIdType id_r )
480 : SolvableIterator::iterator_adaptor_( 0 )
481 { assignVal( Solvable( id_r ) ); }
484 friend class boost::iterator_core_access;
486 Solvable dereference() const
490 { assignVal( _val.nextInPool() ); }
493 void assignVal( const Solvable & val_r )
494 { _val = val_r; base_reference() = _val.get(); }
498 } // namespace detail
499 ///////////////////////////////////////////////////////////////////
501 ///////////////////////////////////////////////////////////////////
504 ///////////////////////////////////////////////////////////////////
507 /** To Solvable transform functor.
509 * \relates sat::SolvIterMixin
513 typedef Solvable result_type;
515 Solvable operator()( const Solvable & solv_r ) const
518 Solvable operator()( const PoolItem & pi_r ) const;
520 Solvable operator()( const ResObject_constPtr & res_r ) const;
523 ///////////////////////////////////////////////////////////////////
525 ///////////////////////////////////////////////////////////////////
527 ZYPP_DEFINE_ID_HASHABLE( ::zypp::sat::Solvable );
529 #endif // ZYPP_SAT_SOLVABLE_H