Imported Upstream version 14.45.0
[platform/upstream/libzypp.git] / zypp / sat / Solvable.h
index 173b6af..2113b42 100644 (file)
 
 #include <iosfwd>
 
-#include "zypp/base/SafeBool.h"
-
 #include "zypp/sat/detail/PoolMember.h"
-#include "zypp/sat/Capabilities.h"
-#include "zypp/sat/Capability.h"
-
+#include "zypp/sat/SolvAttr.h"
 #include "zypp/ResTraits.h"
 #include "zypp/IdString.h"
 #include "zypp/Edition.h"
 #include "zypp/Arch.h"
 #include "zypp/Dep.h"
+#include "zypp/Capabilities.h"
+#include "zypp/Capability.h"
+#include "zypp/Locale.h"
 
 ///////////////////////////////////////////////////////////////////
 namespace zypp
 { /////////////////////////////////////////////////////////////////
+
+  class CheckSum;
+  class OnMediaLocation;
+
   ///////////////////////////////////////////////////////////////////
   namespace sat
   { /////////////////////////////////////////////////////////////////
@@ -39,7 +42,7 @@ namespace zypp
     //
     /** A \ref Solvable object within the sat \ref Pool.
      *
-     * \note Unfortunately libsatsolver combines the objects kind and
+     * \note Unfortunately libsolv combines the objects kind and
      * name in a single identifier \c "pattern:kde_multimedia",
      * \b except for packages and source packes. They are not prefixed
      * by any kind string. Instead the architecture is abused to store
@@ -48,45 +51,154 @@ namespace zypp
      * \ref Solvable will hide this inconsistency by treating source
      * packages as an own kind of solvable and map their arch to
      * \ref Arch_noarch.
-     *
-     *
      */
-    class Solvable : protected detail::PoolMember,
-                     private base::SafeBool<Solvable>
+    class Solvable : protected detail::PoolMember
     {
       public:
-        /** Default ctor creates \ref nosolvable.*/
+        typedef sat::detail::SolvableIdType IdType;
+
+      public:
+        /** Default ctor creates \ref noSolvable.*/
         Solvable()
         : _id( detail::noSolvableId ) {}
 
         /** \ref PoolImpl ctor. */
-        explicit Solvable( detail::SolvableIdType id_r )
+        explicit Solvable( IdType id_r )
         : _id( id_r ) {}
 
       public:
         /** Represents no \ref Solvable. */
-        static const Solvable nosolvable;
+        static const Solvable noSolvable;
 
-        /** Evaluate \ref Solvable in a boolean context (\c != \c nosolvable). */
-        using base::SafeBool<Solvable>::operator bool_type;
+        /** Evaluate \ref Solvable in a boolean context (\c != \c noSolvable). */
+        explicit operator bool() const
+        { return get(); }
 
-        /** Return whether this \ref Solvable belongs to the system repo. */
+        /** Return whether this \ref Solvable belongs to the system repo.
+         * \note This includes the otherwise hidden systemSolvable.
+        */
         bool isSystem() const;
 
+       /** Whether this is known to be installed on behalf of a user request.
+        * \note This is a hint guessed by evaluating an available install history.
+        * Returns \c false for non-system (uninstalled) solvables, or if no history
+        * is available.
+        */
+       bool onSystemByUser() const;
+
         /** The \ref Repository this \ref Solvable belongs to. */
-        Repo repo() const;
+        Repository repository() const;
 
       public:
+
+        /** \name Attribute lookup.
+         * \see \ref LookupAttr and  \ref ArrayAttr providing a general, more
+         * query like interface for attribute retrieval.
+        */
+        //@{
+        /**
+         * returns the string attribute value for \ref attr
+         * or an empty string if it does not exists.
+         */
+        std::string lookupStrAttribute( const SolvAttr & attr ) const;
+        /** \overload Trying to look up a translated string attribute.
+         *
+         * Returns the translation for \c lang_r.
+         *
+         * Passing an empty \ref Locale will return the string for the
+         * current default locale (\see \ref ZConfig::TextLocale),
+         * \b considering all fallback locales.
+         *
+         * Returns an empty string if no translation is available.
+        */
+        std::string lookupStrAttribute( const SolvAttr & attr, const Locale & lang_r ) const;
+
+        /**
+         * returns the numeric attribute value for \ref attr
+         * or 0 if it does not exists.
+         */
+        unsigned long long lookupNumAttribute( const SolvAttr & attr ) const;
+
+        /**
+         * returns the boolean attribute value for \ref attr
+         * or \c false if it does not exists.
+         */
+        bool lookupBoolAttribute( const SolvAttr & attr ) const;
+
+       /**
+         * returns the id attribute value for \ref attr
+         * or \ref detail::noId if it does not exists.
+         */
+        detail::IdType lookupIdAttribute( const SolvAttr & attr ) const;
+
+       /**
+         * returns the CheckSum attribute value for \ref attr
+         * or an empty CheckSum if ir does not exist.
+         */
+        CheckSum lookupCheckSumAttribute( const SolvAttr & attr ) const;
+
+        /**
+         * returns OnMediaLocation data: This is everything we need to
+         * download e.g. an rpm (path, checksum, downloadsize, etc.).
+         */
+        OnMediaLocation lookupLocation() const;
+
+        //@}
+      public:
+        /** The identifier.
+         * This is the solvables \ref name, \b except for packages and
+         * source packes, prefixed by it's \ref kind.
+         */
         IdString     ident()    const;
 
         ResKind      kind()     const;
+        /** Test whether a Solvable is of a certain \ref ResKind.
+        * The test is far cheaper than actually retriveing and
+         * comparing the \ref kind.
+        */
+        bool isKind( const ResKind & kind_r ) const;
+        /** \overload */
+        template<class _Res>
+        bool isKind() const
+        { return isKind( resKind<_Res>() ); }
+        /** \overload Extend the test to a range of \ref ResKind. */
+        template<class _Iterator>
+        bool isKind( _Iterator begin, _Iterator end )
+        { for_( it, begin, end ) if ( isKind( *it ) ) return true; return false; }
+
         std::string  name()     const;
         Edition      edition()  const;
         Arch         arch()     const;
 
         IdString     vendor()   const;
 
-      public:
+        /** Whether different versions of this package can be installed at the same time.
+         * Per default \c false. \see also \ref ZConfig::multiversion.
+         */
+        bool         multiversionInstall() const;
+
+        /** String representation <tt>"ident-edition.arch"</tt> or \c "noSolvable"
+         * \code
+         *   product:openSUSE-11.1.x86_64
+         *   autoyast2-2.16.19-0.1.src
+         *   noSolvable
+         * \endcode
+        */
+        std::string asString() const;
+
+       /** String representation <tt>"ident-edition.arch(repo)"</tt> or \c "noSolvable" */
+        std::string asUserString() const;
+
+        /** Test whether two Solvables have the same content.
+         * Basically the same name, edition, arch, vendor and buildtime.
+         */
+        bool identical( Solvable rhs ) const;
+
+        /** Test for same name-version-release.arch */
+        bool sameNVRA( Solvable rhs ) const
+        { return( ident() == rhs.ident() && edition() == rhs.edition() && arch() == rhs.arch() ); }
+
+     public:
 
         /** \name Access to the \ref Solvable dependencies.
          *
@@ -101,28 +213,82 @@ namespace zypp
         Capabilities obsoletes()   const;
         Capabilities recommends()  const;
         Capabilities suggests()    const;
-        Capabilities freshens()    const;
         Capabilities enhances()    const;
         Capabilities supplements() const;
         Capabilities prerequires() const;
+
+        /** Return the namespaced provides <tt>'namespace([value])[ op edition]'</tt> of this Solvable. */
+        CapabilitySet providesNamespace( const std::string & namespace_r ) const;
+
+        /** Return <tt>'value[ op edition]'</tt> for namespaced provides <tt>'namespace(value)[ op edition]'</tt>.
+         * Similar to \ref providesNamespace, but the namespace is stripped from the
+         * dependencies. This is convenient if the namespace denotes packages that
+         * should be looked up. E.g. the \c weakremover namespace used in a products
+         * release package denotes the packages that were dropped from the distribution.
+         * \see \ref Product::droplist
+         */
+        CapabilitySet valuesOfNamespace( const std::string & namespace_r ) const;
+        //@}
+
+      public:
+        /** \name Locale support. */
+        //@{
+        /** Whether this \c Solvable claims to support locales. */
+        bool supportsLocales() const;
+        /** Whether this \c Solvable supports a specific \ref Locale. */
+        bool supportsLocale( const Locale & locale_r ) const;
+        /** Whether this \c Solvable supports at least one of the specified locales. */
+        bool supportsLocale( const LocaleSet & locales_r ) const;
+        /** Whether this \c Solvable supports at least one requested locale.
+         * \see \ref Pool::setRequestedLocales
+        */
+        bool supportsRequestedLocales() const;
+        /** Return the supported locales via locales_r. */
+        void getSupportedLocales( LocaleSet & locales_r ) const;
+        /** \overload */
+        LocaleSet getSupportedLocales() const
+        { LocaleSet ret; getSupportedLocales( ret ); return ret; }
         //@}
 
       public:
-        /** Return next Solvable in \ref Pool (or \ref nosolvable). */
+        /** Return next Solvable in \ref Pool (or \ref noSolvable). */
         Solvable nextInPool() const;
-        /** Return next Solvable in \ref Repo (or \ref nosolvable). */
+        /** Return next Solvable in \ref Repo (or \ref noSolvable). */
         Solvable nextInRepo() const;
 
+        /** Helper that splits an identifier into kind and name or vice versa.
+        * \note In case \c name_r is preceded by a well known kind spec, the
+        * \c kind_r argument is ignored, and kind is derived from name.
+         * \see \ref ident
+         */
+        class SplitIdent
+        {
+          public:
+            SplitIdent() {}
+            SplitIdent( IdString ident_r );
+            SplitIdent( const char * ident_r );
+            SplitIdent( const std::string & ident_r );
+            SplitIdent( ResKind kind_r, IdString name_r );
+            SplitIdent( ResKind kind_r, const C_Str & name_r );
+
+            IdString ident() const { return _ident; }
+            ResKind  kind()  const { return _kind; }
+            IdString name()  const { return _name; }
+
+          private:
+            IdString  _ident;
+            ResKind   _kind;
+            IdString  _name;
+        };
+
       public:
         /** Expert backdoor. */
         ::_Solvable * get() const;
         /** Expert backdoor. */
-        detail::SolvableIdType id() const { return _id; }
-      private:
-        friend base::SafeBool<Solvable>::operator bool_type() const;
-        bool boolTest() const { return get(); }
+        IdType id() const { return _id; }
+
       private:
-        detail::SolvableIdType _id;
+        IdType _id;
     };
     ///////////////////////////////////////////////////////////////////
 
@@ -132,6 +298,9 @@ namespace zypp
     /** \relates Solvable More verbose stream output including dependencies */
     std::ostream & dumpOn( std::ostream & str, const Solvable & obj );
 
+    /** \relates Solvable XML output */
+    std::ostream & dumpAsXmlOn( std::ostream & str, const Solvable & obj );
+
     /** \relates Solvable */
     inline bool operator==( const Solvable & lhs, const Solvable & rhs )
     { return lhs.get() == rhs.get(); }
@@ -144,6 +313,45 @@ namespace zypp
     inline bool operator<( const Solvable & lhs, const Solvable & rhs )
     { return lhs.get() < rhs.get(); }
 
+    /** \relates Solvable Test for same content. */
+    inline bool identical( Solvable lhs, Solvable rhs )
+    { return lhs.identical( rhs ); }
+
+    /** \relates Solvable Test for same name version release and arch. */
+    inline bool sameNVRA( Solvable lhs, Solvable rhs )
+    { return lhs.sameNVRA( rhs ); }
+
+
+    /** \relates Solvable Compare according to \a kind and \a name. */
+    inline int compareByN( const Solvable & lhs, const Solvable & rhs )
+    {
+      int res = 0;
+      if ( lhs != rhs )
+      {
+       if ( (res = lhs.kind().compare( rhs.kind() )) == 0 )
+         res = lhs.name().compare( rhs.name() );
+      }
+      return res;
+    }
+
+    /** \relates Solvable Compare according to \a kind, \a name and \a edition. */
+    inline int compareByNVR( const Solvable & lhs, const Solvable & rhs )
+    {
+      int res = compareByN( lhs, rhs );
+      if ( res == 0 )
+       res = lhs.edition().compare( rhs.edition() );
+      return res;
+    }
+
+    /** \relates Solvable Compare according to \a kind, \a name, \a edition and \a arch. */
+    inline int compareByNVRA( const Solvable & lhs, const Solvable & rhs )
+    {
+      int res = compareByNVR( lhs, rhs );
+      if ( res == 0 )
+       res = lhs.arch().compare( rhs.arch() );
+      return res;
+    }
+
     ///////////////////////////////////////////////////////////////////
     namespace detail
     { /////////////////////////////////////////////////////////////////
@@ -155,9 +363,9 @@ namespace zypp
       class SolvableIterator : public boost::iterator_adaptor<
           SolvableIterator                   // Derived
           , ::_Solvable*                     // Base
-          , Solvable                         // Value
-          , boost::single_pass_traversal_tag // CategoryOrTraversal
-          , Solvable                         // Reference
+          , const Solvable                   // Value
+          , boost::forward_traversal_tag     // CategoryOrTraversal
+          , const Solvable                   // Reference
           >
       {
         public:
@@ -176,12 +384,13 @@ namespace zypp
         private:
           friend class boost::iterator_core_access;
 
-          void increment()
-          { assignVal( _val.nextInPool() ); }
-
           Solvable dereference() const
           { return _val; }
 
+          void increment()
+          { assignVal( _val.nextInPool() ); }
+
+        private:
           void assignVal( const Solvable & val_r )
           { _val = val_r; base_reference() = _val.get(); }
 
@@ -192,10 +401,42 @@ namespace zypp
     } // namespace detail
     ///////////////////////////////////////////////////////////////////
 
-   /////////////////////////////////////////////////////////////////
+    /////////////////////////////////////////////////////////////////
   } // namespace sat
   ///////////////////////////////////////////////////////////////////
+
+  /** \relates sat::Solvable Test whether a \ref sat::Solvable is of a certain Kind. */
+  template<class _Res>
+  inline bool isKind( const sat::Solvable & solvable_r )
+  { return solvable_r.isKind( ResTraits<_Res>::kind ); }
+
+  class PoolItem;
+  ///////////////////////////////////////////////////////////////////
+  namespace sat
+  { /////////////////////////////////////////////////////////////////
+    /** To Solvable transform functor.
+     * \relates Solvable
+     * \relates sat::SolvIterMixin
+     */
+    struct asSolvable
+    {
+      typedef Solvable result_type;
+
+      Solvable operator()( Solvable solv_r ) const
+      { return solv_r; }
+
+      Solvable operator()( const PoolItem & pi_r ) const;
+
+      Solvable operator()( const ResObject_constPtr & res_r ) const;
+    };
+    /////////////////////////////////////////////////////////////////
+  } // namespace sat
+  ///////////////////////////////////////////////////////////////////
+
   /////////////////////////////////////////////////////////////////
 } // namespace zypp
 ///////////////////////////////////////////////////////////////////
+
+ZYPP_DEFINE_ID_HASHABLE( ::zypp::sat::Solvable );
+
 #endif // ZYPP_SAT_SOLVABLE_H