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 This is a hint guessed by evaluating an available install history.
125 * Returns \c false for non-system (uninstalled) solvables, or if no history
128 bool onSystemByUser() const;
130 /** Whether different versions of this package can be installed at the same time.
131 * Per default \c false. \see also \ref ZConfig::multiversion.
133 bool multiversionInstall() const;
135 /** The items build time. */
136 Date buildtime() const;
138 /** The items install time (\c false if not installed). */
139 Date installtime() const;
142 /** String representation <tt>"ident-edition.arch"</tt> or \c "noSolvable"
144 * product:openSUSE-11.1.x86_64
145 * autoyast2-2.16.19-0.1.src
149 std::string asString() const;
151 /** String representation <tt>"ident-edition.arch(repo)"</tt> or \c "noSolvable" */
152 std::string asUserString() const;
154 /** Test whether two Solvables have the same content.
155 * Basically the same name, edition, arch, vendor and buildtime.
157 bool identical( const Solvable & rhs ) const;
159 /** Test for same name-version-release.arch */
160 bool sameNVRA( const Solvable & rhs ) const
161 { return( get() == rhs.get() || ( ident() == rhs.ident() && edition() == rhs.edition() && arch() == rhs.arch() ) ); }
164 /** \name Access to the \ref Solvable dependencies.
166 * \note Prerequires are a subset of requires.
169 Capabilities provides() const;
170 Capabilities requires() const;
171 Capabilities conflicts() const;
172 Capabilities obsoletes() const;
173 Capabilities recommends() const;
174 Capabilities suggests() const;
175 Capabilities enhances() const;
176 Capabilities supplements() const;
177 Capabilities prerequires() const;
179 /** Return \ref Capabilities selected by \ref Dep constant. */
180 Capabilities dep( Dep which_r ) const
182 switch( which_r.inSwitch() )
184 case Dep::PROVIDES_e: return provides(); break;
185 case Dep::REQUIRES_e: return requires(); break;
186 case Dep::CONFLICTS_e: return conflicts(); break;
187 case Dep::OBSOLETES_e: return obsoletes(); break;
188 case Dep::RECOMMENDS_e: return recommends(); break;
189 case Dep::SUGGESTS_e: return suggests(); break;
190 case Dep::ENHANCES_e: return enhances(); break;
191 case Dep::SUPPLEMENTS_e: return supplements(); break;
192 case Dep::PREREQUIRES_e: return prerequires(); break;
194 return Capabilities();
196 /** \overload operator[] */
197 Capabilities operator[]( Dep which_r ) const
198 { return dep( which_r ); }
201 /** Return the namespaced provides <tt>'namespace([value])[ op edition]'</tt> of this Solvable. */
202 CapabilitySet providesNamespace( const std::string & namespace_r ) const;
204 /** Return <tt>'value[ op edition]'</tt> for namespaced provides <tt>'namespace(value)[ op edition]'</tt>.
205 * Similar to \ref providesNamespace, but the namespace is stripped from the
206 * dependencies. This is convenient if the namespace denotes packages that
207 * should be looked up. E.g. the \c weakremover namespace used in a products
208 * release package denotes the packages that were dropped from the distribution.
209 * \see \ref Product::droplist
211 CapabilitySet valuesOfNamespace( const std::string & namespace_r ) const;
215 /** \name Locale support. */
217 /** Whether this \c Solvable claims to support locales. */
218 bool supportsLocales() const;
219 /** Whether this \c Solvable supports a specific \ref Locale. */
220 bool supportsLocale( const Locale & locale_r ) const;
221 /** Whether this \c Solvable supports at least one of the specified locales. */
222 bool supportsLocale( const LocaleSet & locales_r ) const;
223 /** Whether this \c Solvable supports at least one requested locale.
224 * \see \ref Pool::setRequestedLocales
226 bool supportsRequestedLocales() const;
227 /** Return the supported locales. */
228 LocaleSet getSupportedLocales() const;
229 /** \overload Legacy return via arg \a locales_r */
230 void getSupportedLocales( LocaleSet & locales_r ) const
231 { locales_r = getSupportedLocales(); }
235 /** The solvables CpeId if available. */
238 /** Media number the solvable is located on (\c 0 if no media access required). */
239 unsigned mediaNr() const;
241 /** Installed (unpacked) size.
242 * This is just a total number. Many objects provide even more detailed
243 * disk usage data. You can use \ref DiskUsageCounter to find out
244 * how objects data are distributed across partitions/directories.
246 * // Load directory set into ducounter
247 * DiskUsageCounter ducounter( { "/", "/usr", "/var" } );
249 * // see how noch space the packages use
250 * for ( const PoolItem & pi : pool )
252 * cout << pi << ducounter.disk_usage( pi ) << endl;
253 * // I__s_(7)GeoIP-1.4.8-3.1.2.x86_64(@System) {
254 * // dir:[/] [ bs: 0 B ts: 0 B us: 0 B (+-: 1.0 KiB)]
255 * // dir:[/usr] [ bs: 0 B ts: 0 B us: 0 B (+-: 133.0 KiB)]
256 * // dir:[/var] [ bs: 0 B ts: 0 B us: 0 B (+-: 1.1 MiB)]
260 * \see \ref DiskUsageCounter
262 ByteCount installSize() const;
264 /** Download size. */
265 ByteCount downloadSize() const;
267 /** The distribution string. */
268 std::string distribution() const;
270 /** Short (singleline) text describing the solvable (opt. translated). */
271 std::string summary( const Locale & lang_r = Locale() ) const;
273 /** Long (multiline) text describing the solvable (opt. translated). */
274 std::string description( const Locale & lang_r = Locale() ) const;
276 /** UI hint text when selecting the solvable for install (opt. translated). */
277 std::string insnotify( const Locale & lang_r = Locale() ) const;
278 /** UI hint text when selecting the solvable for uninstall (opt. translated).*/
279 std::string delnotify( const Locale & lang_r = Locale() ) const;
281 /** License or agreement to accept before installing the solvable (opt. translated). */
282 std::string licenseToConfirm( const Locale & lang_r = Locale() ) const;
283 /** \c True except for well known exceptions (i.e show license but no need to accept it). */
284 bool needToAcceptLicense() const;
287 /** Helper that splits an identifier into kind and name or vice versa.
288 * \note In case \c name_r is preceded by a well known kind spec, the
289 * \c kind_r argument is ignored, and kind is derived from name.
296 SplitIdent( IdString ident_r );
297 SplitIdent( const char * ident_r );
298 SplitIdent( const std::string & ident_r );
299 SplitIdent( ResKind kind_r, IdString name_r );
300 SplitIdent( ResKind kind_r, const C_Str & name_r );
302 IdString ident() const { return _ident; }
303 ResKind kind() const { return _kind; }
304 IdString name() const { return _name; }
313 /** \name Attribute lookup.
314 * \see \ref LookupAttr and \ref ArrayAttr providing a general, more
315 * query like interface for attribute retrieval.
319 * returns the string attribute value for \ref attr
320 * or an empty string if it does not exists.
322 std::string lookupStrAttribute( const SolvAttr & attr ) const;
323 /** \overload Trying to look up a translated string attribute.
325 * Returns the translation for \c lang_r.
327 * Passing an empty \ref Locale will return the string for the
328 * current default locale (\see \ref ZConfig::TextLocale),
329 * \b considering all fallback locales.
331 * Returns an empty string if no translation is available.
333 std::string lookupStrAttribute( const SolvAttr & attr, const Locale & lang_r ) const;
336 * returns the numeric attribute value for \ref attr
337 * or 0 if it does not exists.
339 unsigned long long lookupNumAttribute( const SolvAttr & attr ) const;
340 /** \overload returning custom notfound_r value */
341 unsigned long long lookupNumAttribute( const SolvAttr & attr, unsigned long long notfound_r ) const;
344 * returns the boolean attribute value for \ref attr
345 * or \c false if it does not exists.
347 bool lookupBoolAttribute( const SolvAttr & attr ) const;
350 * returns the id attribute value for \ref attr
351 * or \ref detail::noId if it does not exists.
353 detail::IdType lookupIdAttribute( const SolvAttr & attr ) const;
356 * returns the CheckSum attribute value for \ref attr
357 * or an empty CheckSum if ir does not exist.
359 CheckSum lookupCheckSumAttribute( const SolvAttr & attr ) const;
362 * returns OnMediaLocation data: This is everything we need to
363 * download e.g. an rpm (path, checksum, downloadsize, etc.).
365 OnMediaLocation lookupLocation() const;
369 /** Return next Solvable in \ref Pool (or \ref noSolvable). */
370 Solvable nextInPool() const;
371 /** Return next Solvable in \ref Repo (or \ref noSolvable). */
372 Solvable nextInRepo() const;
373 /** Expert backdoor. */
374 detail::CSolvable * get() const;
375 /** Expert backdoor. */
376 IdType id() const { return _id; }
381 ///////////////////////////////////////////////////////////////////
383 /** \relates Solvable Stream output */
384 std::ostream & operator<<( std::ostream & str, const Solvable & obj );
386 /** \relates Solvable More verbose stream output including dependencies */
387 std::ostream & dumpOn( std::ostream & str, const Solvable & obj );
389 /** \relates Solvable XML output */
390 std::ostream & dumpAsXmlOn( std::ostream & str, const Solvable & obj );
392 /** \relates Solvable */
393 inline bool operator==( const Solvable & lhs, const Solvable & rhs )
394 { return lhs.get() == rhs.get(); }
396 /** \relates Solvable */
397 inline bool operator!=( const Solvable & lhs, const Solvable & rhs )
398 { return lhs.get() != rhs.get(); }
400 /** \relates Solvable */
401 inline bool operator<( const Solvable & lhs, const Solvable & rhs )
402 { return lhs.get() < rhs.get(); }
404 /** \relates Solvable Test whether a \ref Solvable is of a certain Kind. */
406 inline bool isKind( const Solvable & solvable_r )
407 { return solvable_r.isKind( ResTraits<TRes>::kind ); }
409 /** \relates Solvable Test for same content. */
410 inline bool identical( const Solvable & lhs, const Solvable & rhs )
411 { return lhs.identical( rhs ); }
413 /** \relates Solvable Test for same name version release and arch. */
414 inline bool sameNVRA( const Solvable & lhs, const Solvable & rhs )
415 { return lhs.sameNVRA( rhs ); }
418 /** \relates Solvable Compare according to \a kind and \a name. */
419 inline int compareByN( const Solvable & lhs, const Solvable & rhs )
424 if ( (res = lhs.kind().compare( rhs.kind() )) == 0 )
425 res = lhs.name().compare( rhs.name() );
430 /** \relates Solvable Compare according to \a kind, \a name and \a edition. */
431 inline int compareByNVR( const Solvable & lhs, const Solvable & rhs )
433 int res = compareByN( lhs, rhs );
435 res = lhs.edition().compare( rhs.edition() );
439 /** \relates Solvable Compare according to \a kind, \a name, \a edition and \a arch. */
440 inline int compareByNVRA( const Solvable & lhs, const Solvable & rhs )
442 int res = compareByNVR( lhs, rhs );
444 res = lhs.arch().compare( rhs.arch() );
448 ///////////////////////////////////////////////////////////////////
451 ///////////////////////////////////////////////////////////////////
453 // CLASS NAME : SolvableIterator
456 class SolvableIterator : public boost::iterator_adaptor<
457 SolvableIterator // Derived
459 , const Solvable // Value
460 , boost::forward_traversal_tag // CategoryOrTraversal
461 , const Solvable // Reference
466 : SolvableIterator::iterator_adaptor_( 0 )
469 explicit SolvableIterator( const Solvable & val_r )
470 : SolvableIterator::iterator_adaptor_( 0 )
471 { assignVal( val_r ); }
473 explicit SolvableIterator( SolvableIdType id_r )
474 : SolvableIterator::iterator_adaptor_( 0 )
475 { assignVal( Solvable( id_r ) ); }
478 friend class boost::iterator_core_access;
480 Solvable dereference() const
484 { assignVal( _val.nextInPool() ); }
487 void assignVal( const Solvable & val_r )
488 { _val = val_r; base_reference() = _val.get(); }
492 } // namespace detail
493 ///////////////////////////////////////////////////////////////////
495 ///////////////////////////////////////////////////////////////////
498 ///////////////////////////////////////////////////////////////////
501 /** To Solvable transform functor.
503 * \relates sat::SolvIterMixin
507 typedef Solvable result_type;
509 Solvable operator()( const Solvable & solv_r ) const
512 Solvable operator()( const PoolItem & pi_r ) const;
514 Solvable operator()( const ResObject_constPtr & res_r ) const;
517 ///////////////////////////////////////////////////////////////////
519 ///////////////////////////////////////////////////////////////////
521 ZYPP_DEFINE_ID_HASHABLE( ::zypp::sat::Solvable );
523 #endif // ZYPP_SAT_SOLVABLE_H