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

/*
 * Copyright (c) 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
 *
 * 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_CONTENTS_HH
#define PALUDIS_GUARD_PALUDIS_CONTENTS_HH 1

#include <paludis/util/visitor.hh>
#include <paludis/util/counted_ptr.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <string>

#include <libwrapiter/libwrapiter_forward_iterator.hh>

/** \file
 * Declarations for the Contents classes.
 *
 * \ingroup grpcontents
 */

namespace paludis
{
    struct ContentsEntry;
    struct ContentsFileEntry;
    struct ContentsDirEntry;
    struct ContentsSymEntry;
    struct ContentsMiscEntry;

    /**
     * Visit a contents heirarchy.
     *
     * \ingroup grpcontents
     */
    typedef VisitorTypes<ContentsFileEntry *, ContentsDirEntry *,
            ContentsSymEntry *, ContentsMiscEntry *> ContentsVisitorTypes;

    /**
     * Base class for a contents entry.
     *
     * \ingroup grpcontents
     */
    class ContentsEntry :
        private InstantiationPolicy<ContentsEntry, instantiation_method::NonCopyableTag>,
        public InternalCounted<ContentsEntry>,
        public virtual VisitableInterface<ContentsVisitorTypes>
    {
        private:
            std::string _name;

        protected:
            ///\name Basic operations
            ///\{

            ContentsEntry(const std::string & name) :
                _name(name)
            {
            }

            ///\}

        public:
            ///\name Basic operations
            ///\{

            virtual ~ContentsEntry();

            ///\}

            /// Our name.
            std::string name() const
            {
                return _name;
            }
    };

    /**
     * A file contents entry.
     *
     * \ingroup grpcontents
     */
    class ContentsFileEntry :
        public ContentsEntry,
        public Visitable<ContentsFileEntry, ContentsVisitorTypes>
    {
        public:
            ///\name Basic operations
            ///\{

            ContentsFileEntry(const std::string & name);

            ///\}
    };

    /**
     * A directory contents entry.
     *
     * \ingroup grpcontents
     */
    class ContentsDirEntry :
        public ContentsEntry,
        public Visitable<ContentsDirEntry, ContentsVisitorTypes>
    {
        public:
            ///\name Basic operations
            ///\{

            ContentsDirEntry(const std::string & name);

            ///\}
    };

    /**
     * A misc contents entry.
     *
     * \ingroup grpcontents
     */
    class ContentsMiscEntry :
        public ContentsEntry,
        public Visitable<ContentsMiscEntry, ContentsVisitorTypes>
    {
        public:
            ///\name Basic operations
            ///\{

            ContentsMiscEntry(const std::string & name);

            ///\}
    };

    /**
     * A sym contents entry.
     *
     * \ingroup grpcontents
     */
    class ContentsSymEntry :
        public ContentsEntry,
        public Visitable<ContentsSymEntry, ContentsVisitorTypes>
    {
        private:
            std::string _target;

        public:
            ///\name Basic operations
            ///\{

            ContentsSymEntry(const std::string & name, const std::string & target);

            ///\}

            /// Our target (as per readlink).
            std::string target() const
            {
                return _target;
            }
    };

    /**
     * A package's contents.
     *
     * \ingroup grpcontents
     */
    class Contents :
        private InstantiationPolicy<Contents, instantiation_method::NonCopyableTag>,
        private PrivateImplementationPattern<Contents>,
        public InternalCounted<Contents>
    {
        public:
            ///\name Basic operations
            ///\{

            Contents();
            ~Contents();

            ///\}

            /// Add a new entry.
            void add(ContentsEntry::ConstPointer c);

            ///\name Iterate over our entries
            ///\{

            typedef libwrapiter::ForwardIterator<Contents, const ContentsEntry::ConstPointer> Iterator;

            Iterator begin() const;

            Iterator end() const;

            ///\}
    };
}

#endif