- Add method Product::replacedProducts to identify installed

[platform/upstream/libzypp.git] / zypp / sat / WhatProvides.h

diff --git a/zypp/sat/WhatProvides.h b/zypp/sat/WhatProvides.h
index df88edc..1f827d6 100644 (file)
--- a/zypp/sat/WhatProvides.h
+++ b/zypp/sat/WhatProvides.h
@@ -6,17 +6,19 @@
 |                         /_____||_| |_| |_|                           |
 |                                                                      |
 \---------------------------------------------------------------------*/
-/** \file      zypp/sat/.h
+/** \file      zypp/sat/WhatProvides.h
  *
 */
 #ifndef ZYPP_SAT_WHATPROVIDES_H
 #define ZYPP_SAT_WHATPROVIDES_H
 
 #include <iosfwd>
+#include <vector>
 
-#include "zypp/base/DefaultIntegral.h"
+#include "zypp/base/PtrTypes.h"
 #include "zypp/sat/detail/PoolMember.h"
 #include "zypp/sat/Solvable.h"
+#include "zypp/sat/SolvIterMixin.h"
 
 ///////////////////////////////////////////////////////////////////
 namespace zypp
@@ -25,23 +27,65 @@ namespace zypp
   namespace sat
   { /////////////////////////////////////////////////////////////////
 
+    namespace detail
+    {
+      class WhatProvidesIterator;
+    }
+
     ///////////////////////////////////////////////////////////////////
     //
     // CLASS NAME : WhatProvides
     //
     /** Container of \ref Solvable providing a \ref Capability (read only).
+     *
      * \code
      * Capability cap("amarok < 1.13");
+     *
      * WhatProvides q( cap );
+     * Solvable firstMatch;
+     *
      * if ( ! q.empty() )
      * {
      *   cout << "Found " << q.size() << " matches for " << cap << ":" << endl;
+     *   firstMatch = *q.begin();
+     *
      *   for_( it, q.begin(), q.end() )
-     *     cout << *it << end;
+     *     cout << *it << endl;
+     * }
+     *
+     * if ( firstMatch )
+     * {
+     *   WhatProvides req( firstMatch.requires() );
+     *   if ( ! req.empty() )
+     *   {
+     *      cout << "Found " << req.size() << " items providing requirements of " << firstMatch << ":" << endl;
+     *   }
+     * }
+     * \endcode
+     *
+     * \note Note that there are capabilities which are not provided by any \ref Solvable,
+     * but are system properties. For example:
+     * \code
+     *   rpmlib(PayloadIsBzip2) <= 3.0.5-1
+     * \endcode
+     * In that case a \ref Solvable::noSolvable is returned, which has \c isSystem set \c true, although
+     * there should never be a \ref Solvable::noSolvable returned with \c isSystem set \c false. If so,
+     * please file a bugreport.
+     * \code
+     * WhatProvides q( Capability("rpmlib(PayloadIsBzip2) <= 3.0.5-1") );
+     * for_( it, q.begin(), q.end() )
+     * {
+     *   if ( *it )
+     *     cout << "Capability is provided by package " << *it << endl;
+     *   else if ( it->isSystem() )
+     *     cout << "Capability is a system property" << endl;
+     *   else
+     *     ; // never reaching this \c else
      * }
      * \endcode
      */
-    class WhatProvides : protected detail::PoolMember
+    class WhatProvides : public SolvIterMixin<WhatProvides,detail::WhatProvidesIterator>,
+                         protected detail::PoolMember
     {
       public:
         typedef Solvable  value_type;
@@ -53,11 +97,19 @@ namespace zypp
         : _begin( 0 )
         {}
 
-        /** Ctor from Id pointer (friend \ref Solvable). */
+        /** Ctor from \ref Capability. */
         explicit
         WhatProvides( Capability cap_r );
 
-      public:
+        /** Ctor collecting all providers of capabilities in \c caps_r. */
+        explicit
+        WhatProvides( Capabilities caps_r );
+
+        /** Ctor collecting all providers of capabilities in \c caps_r. */
+        explicit
+        WhatProvides( const CapabilitySet & caps_r );
+
+     public:
         /** Whether the container is empty. */
         bool empty() const
         { return ! ( _begin && *_begin ); }
@@ -66,7 +118,7 @@ namespace zypp
         size_type size() const;
 
       public:
-        class const_iterator;
+        typedef detail::WhatProvidesIterator const_iterator;
 
         /** Iterator pointing to the first \ref Solvable. */
         const_iterator begin() const;
@@ -76,20 +128,24 @@ namespace zypp
 
       private:
         const sat::detail::IdType * _begin;
+        shared_ptr<void> _private;
     };
     ///////////////////////////////////////////////////////////////////
 
     /** \relates WhatProvides Stream output */
     std::ostream & operator<<( std::ostream & str, const WhatProvides & obj );
 
+    namespace detail
+    {
     ///////////////////////////////////////////////////////////////////
     //
     // CLASS NAME : WhatProvides::const_iterator
     //
     /** \ref WhatProvides iterator.
+     * Iterate a NULL terminated sat::detail::IdType array.
      */
-    class WhatProvides::const_iterator : public boost::iterator_adaptor<
-          const_iterator               // Derived
+    class WhatProvidesIterator : public boost::iterator_adaptor<
+          WhatProvidesIterator         // Derived
         , const detail::IdType *       // Base
         , const Solvable               // Value
         , boost::forward_traversal_tag // CategoryOrTraversal
@@ -97,19 +153,19 @@ namespace zypp
         >
     {
       public:
-        const_iterator()
-        : const_iterator::iterator_adaptor_( 0 )
+        WhatProvidesIterator()
+        : iterator_adaptor_( 0 )
         {}
 
-        explicit const_iterator( const sat::detail::IdType * _idx )
-        : const_iterator::iterator_adaptor_( _idx )
+        explicit WhatProvidesIterator( const sat::detail::IdType * _idx )
+        : iterator_adaptor_( _idx )
         {}
 
       private:
         friend class boost::iterator_core_access;
 
         reference dereference() const
-        { return ( base() ) ? Solvable( *base() ) : Solvable::nosolvable; }
+        { return ( base() ) ? Solvable( *base() ) : Solvable::noSolvable; }
 
         template <class OtherDerived, class OtherIterator, class V, class C, class R, class D>
         bool equal( const boost::iterator_adaptor<OtherDerived, OtherIterator, V, C, R, D> & rhs ) const
@@ -123,6 +179,7 @@ namespace zypp
         { ++base_reference(); }
     };
     ///////////////////////////////////////////////////////////////////
+    }
 
     inline WhatProvides::const_iterator WhatProvides::begin() const
     { return const_iterator( _begin ); }