f34efd7069d11c82bcb99ebb45aafe15c8f3da01
[platform/upstream/libzypp.git] / zypp / sat / WhatObsoletes.h
1 /*---------------------------------------------------------------------\
2 |                          ____ _   __ __ ___                          |
3 |                         |__  / \ / / . \ . \                         |
4 |                           / / \ V /|  _/  _/                         |
5 |                          / /__ | | | | | |                           |
6 |                         /_____||_| |_| |_|                           |
7 |                                                                      |
8 \---------------------------------------------------------------------*/
9 /** \file       zypp/sat/WhatObsoletes.h
10  *
11 */
12 #ifndef ZYPP_SAT_WHATOBSOLETES_H
13 #define ZYPP_SAT_WHATOBSOLETES_H
14
15 #include <iosfwd>
16 #include <vector>
17
18 #include "zypp/sat/WhatProvides.h"
19
20 ///////////////////////////////////////////////////////////////////
21 namespace zypp
22 { /////////////////////////////////////////////////////////////////
23   ///////////////////////////////////////////////////////////////////
24   namespace sat
25   { /////////////////////////////////////////////////////////////////
26
27     ///////////////////////////////////////////////////////////////////
28     //
29     //  CLASS NAME : WhatObsoletes
30     //
31     /** Container of \b installed \ref Solvable which would be
32      *  obsoleted by the \ref Solvable passed to the ctor.
33      *
34      * \todo Publish obsoleteUsesProvides config option.
35      */
36     class WhatObsoletes : public SolvIterMixin<WhatObsoletes,detail::WhatProvidesIterator>,
37                           protected detail::PoolMember
38     {
39       public:
40         typedef Solvable  value_type;
41         typedef unsigned  size_type;
42
43       public:
44         /** Default ctor */
45         WhatObsoletes()
46         : _begin( 0 )
47         {}
48
49         /** Ctor from \ref Solvable. */
50         explicit
51         WhatObsoletes( Solvable item_r );
52
53         /** Ctor from \ref PoolItem. */
54         explicit
55         WhatObsoletes( const PoolItem & item_r );
56
57         /** Ctor from \ref ResObject::constPtr. */
58         explicit
59         WhatObsoletes( const ResObject_constPtr item_r );
60
61         /** Ctor from a range of \ref Solvable, \ref PoolItem or \ref ResObject::constPtr. */
62         template <class _Iterator>
63         WhatObsoletes( _Iterator begin, _Iterator end )
64         : _begin( 0 )
65         {
66           for_( it, begin, end )
67             ctorAdd( *it );
68           ctorDone();
69         }
70
71      public:
72         /** Whether the container is empty. */
73         bool empty() const
74         { return ! ( _begin && *_begin ); }
75
76         /** Number of solvables inside. */
77         size_type size() const;
78
79       public:
80         typedef detail::WhatProvidesIterator const_iterator;
81
82         /** Iterator pointing to the first \ref Solvable. */
83         const_iterator begin() const
84         { return const_iterator( _begin ); }
85
86         /** Iterator pointing behind the last \ref Solvable. */
87         const_iterator end() const
88         { return const_iterator(); }
89
90       private:
91         void ctorAdd( const PoolItem & item_r );
92         void ctorAdd( ResObject_constPtr item_r );
93         void ctorAdd( Solvable item_r );
94         void ctorDone();
95
96       private:
97         const sat::detail::IdType * _begin;
98         shared_ptr<void> _private;
99     };
100     ///////////////////////////////////////////////////////////////////
101
102     /** \relates WhatObsoletes Stream output */
103     std::ostream & operator<<( std::ostream & str, const WhatObsoletes & obj );
104
105     /////////////////////////////////////////////////////////////////
106   } // namespace sat
107   ///////////////////////////////////////////////////////////////////
108   /////////////////////////////////////////////////////////////////
109 } // namespace zypp
110 ///////////////////////////////////////////////////////////////////
111 #endif // ZYPP_SAT_WHATOBSOLETES_H