aboutsummaryrefslogtreecommitdiff
path: root/0.8.0/paludis/util/collection.hh
blob: 920bece1ccc33f0f269c58db5f6720bf293763b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_PALUDIS_SEQUENTIAL_COLLECTION_HH
#define PALUDIS_GUARD_PALUDIS_SEQUENTIAL_COLLECTION_HH 1

#include <paludis/util/counted_ptr.hh>
#include <paludis/util/instantiation_policy.hh>
#include <libwrapiter/libwrapiter.hh>
#include <iterator>

/** \file
 * Various wrappers around collections of items, for convenience and
 * avoiding passing around huge containers.
 *
 * \ingroup grpcollections
 */

namespace paludis
{
    /**
     * Wrapper around a std::list of a particular item. Multiple items
     * with the same value are disallowed.
     *
     * This item cannot be constructed. Use SequentialCollection::Concrete,
     * which requires including paludis/util/collection_concrete.hh .
     *
     * \ingroup grpcollections
     */
    template <typename T_>
    class PALUDIS_VISIBLE SequentialCollection :
        private InstantiationPolicy<SequentialCollection<T_>, instantiation_method::NonCopyableTag>,
        public InternalCounted<SequentialCollection<T_> >,
        public std::iterator<typename std::iterator_traits<
            typename libwrapiter::ForwardIterator<SequentialCollection<T_>, const T_> >::iterator_category, T_>
    {
        protected:
            ///\name Basic operations
            ///\{

            SequentialCollection()
            {
            }

            ///\}

        public:
            class Concrete;

            /**
             * Issue with g++ 3.4.6: const_reference isn't defined via our std::iterator
             * inherit, but it is needed by many standard algorithms.
             */
            typedef const T_ & const_reference;

            ///\name Basic operations
            ///\{

            virtual ~SequentialCollection()
            {
            }

            ///\}

            ///\name Iterate over our items
            ///\{

            typedef libwrapiter::ForwardIterator<SequentialCollection<T_>, const T_> Iterator;

            virtual Iterator begin() const = 0;

            virtual Iterator end() const = 0;

            virtual Iterator last() const = 0;

            ///\}

            ///\name Finding items
            ///\{

            /**
             * Return an Iterator to an item, or end() if there's no match.
             */
            virtual Iterator find(const T_ & v) const = 0;

            ///\}

            ///\name Adding and modifying items
            ///\{

            /**
             * Append an item, return whether we succeeded.
             */
            virtual bool append(T_ v) = 0;

            /**
             * Append an item.
             */
            virtual void push_back(const T_ & v) = 0;

            ///\}

            ///\name Queries
            ///\{

            /**
             * Are we empty?
             */
            virtual bool empty() const = 0;

            ///\}
    };

    /**
     * Wrapper around a std::set of a particular item.
     *
     * This item cannot be constructed. Use SortedCollection::Concrete,
     * which requires including paludis/util/collection_concrete.hh .
     *
     * \ingroup grpcollections
     */
    template <typename T_, typename C_ = std::less<T_> >
    class PALUDIS_VISIBLE SortedCollection :
        private InstantiationPolicy<SortedCollection<T_, C_>, instantiation_method::NonCopyableTag>,
        public InternalCounted<SortedCollection<T_, C_> >,
        public std::iterator<typename std::iterator_traits<
            typename libwrapiter::ForwardIterator<SortedCollection<T_, C_>, const T_> >::iterator_category, T_>
    {
        protected:
            ///\name Basic operations
            ///\{

            SortedCollection()
            {
            }

            ///\}

        public:
            class Concrete;

            ///\name Basic operations
            ///\{

            virtual ~SortedCollection()
            {
            }

            ///\}

            ///\name Iterate over our items
            ///\{

            typedef libwrapiter::ForwardIterator<SortedCollection<T_, C_>, const T_> Iterator;

            virtual Iterator begin() const = 0;

            virtual Iterator end() const = 0;

            struct ReverseTag;
            typedef libwrapiter::ForwardIterator<ReverseTag, const T_> ReverseIterator;

            virtual ReverseIterator rbegin() const = 0;

            virtual ReverseIterator rend() const = 0;

            virtual Iterator last() const = 0;

            ///\}

            ///\name Finding items
            ///\{

            virtual Iterator find(const T_ & v) const = 0;

            virtual int count(const T_ & v) const = 0;

            ///\}

            ///\name Adding, removing and modifying items
            ///\{

            /**
             * Insert an item, return whether we succeeded.
             */
            virtual bool insert(const T_ & v) = 0;

            /**
             * Insert a range of items, return whether we inserted everything.
             */
            template <typename I_>
            bool insert(I_ b, const I_ & e)
            {
                bool result(false);
                for ( ; b != e ; ++b)
                    result |= insert(*b);
                return result;
            }

            /**
             * Erase an item, return whether we succeeded.
             */
            virtual bool erase(const T_ & v) = 0;

            /**
             * Insert all items from another container.
             */
            virtual bool merge(typename SortedCollection<T_, C_>::ConstPointer o) = 0;

            /**
             * Our insert iterator type.
             */
            typedef libwrapiter::OutputIterator<SortedCollection<T_, C_>, T_> Inserter;

            /**
             * Fetch an inserter.
             */
            virtual Inserter inserter() = 0;

            ///\}

            ///\name Queries
            ///\{

            /**
             * Are we empty?
             */
            virtual bool empty() const = 0;

            /**
             * How big are we?
             */
            virtual unsigned size() const = 0;

            ///\}
    };

    /**
     * Wrapper around a std::map of a particular item.
     *
     * This item cannot be constructed. Use AssociativeCollection::Concrete,
     * which requires including paludis/util/collection_concrete.hh .
     *
     * \ingroup grpcollections
     */
    template <typename K_, typename V_>
    class PALUDIS_VISIBLE AssociativeCollection :
        private InstantiationPolicy<AssociativeCollection<K_, V_>, instantiation_method::NonCopyableTag>,
        public InternalCounted<AssociativeCollection<K_, V_> >,
        public std::iterator<typename std::iterator_traits<
            typename libwrapiter::ForwardIterator<AssociativeCollection<K_, V_>,
            const std::pair<const K_, V_> > >::iterator_category, const std::pair<const K_, V_> >
    {
        protected:
            ///\name Basic operations
            ///\{

            AssociativeCollection()
            {
            }

            ///\}

        public:
            class Concrete;

            ///\name Basic operations
            ///\{

            virtual ~AssociativeCollection()
            {
            }

            ///\}

            ///\name Iterate over our items
            ///\{

            typedef libwrapiter::ForwardIterator<AssociativeCollection<K_, V_>,
                    const std::pair<const K_, V_> > Iterator;

            virtual Iterator begin() const = 0;

            virtual Iterator end() const = 0;

            ///\}

            ///\name Finding items
            ///\{

            virtual Iterator find(const K_ & v) const = 0;

            ///\}

            ///\name Adding, removing and modifying items
            ///\{

            /**
             * Insert an item, return whether we succeeded.
             */
            virtual bool insert(const K_ & k, const V_ & v) = 0;

            /**
             * Erase an item, return whether we succeeded.
             */
            virtual bool erase(const K_ & k) = 0;

            /**
             * Erase an item, return whether we succeeded.
             */
            virtual bool erase(const Iterator & i) = 0;

            ///\}

            ///\name Queries
            ///\{

            /**
             * Are we empty?
             */
            virtual bool empty() const = 0;

            ///\}
    };
}

#endif