aboutsummaryrefslogtreecommitdiff
path: root/paludis/sequential_collection.hh
blob: 53689e52e7981e29e84b0177b6b617702f035d1f (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@gentoo.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 <list>
#include <algorithm>
#include <paludis/counted_ptr.hh>
#include <paludis/instantiation_policy.hh>

namespace paludis
{
    /**
     * Wrapper around a std::list of a particular item. Multiple items
     * with the same value are disallowed.
     */
    template <typename T_>
    class SequentialCollection :
        private InstantiationPolicy<SequentialCollection<T_>, instantiation_method::NonCopyableTag>,
        public InternalCounted<SequentialCollection<T_> >
    {
        private:
            std::list<T_> _items;

        public:
            /**
             * Constructor.
             */
            SequentialCollection()
            {
            }

            /**
             * Destructor.
             */
            virtual ~SequentialCollection()
            {
            }

            /**
             * Our iterator type.
             */
            typedef typename std::list<T_>::const_iterator Iterator;

            /**
             * Iterator to the start of our items.
             */
            Iterator begin() const
            {
                return _items.begin();
            }

            /**
             * Iterator to one past our last item.
             */
            Iterator end() const
            {
                return _items.end();
            }

            /**
             * Iterator to our last item.
             */
            Iterator last() const
            {
                return _items.begin() == _items.end() ? _items.end() : --(_items.end());
            }

            /**
             * Return an Iterator to an item, or end() if there's no match.
             */
            Iterator find(const T_ & v) const
            {
                return std::find(_items.begin(), _items.end(), v);
            }

            /**
             * Append an item, return whether we succeeded.
             */
            bool append(T_ v)
            {
                if (end() != find(v))
                    return false;

                _items.push_back(v);
                return true;
            }

            /**
             * Are we empty?
             */
            bool empty() const
            {
                return _items.empty();
            }
    };
}

#endif