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

/*
 * Copyright (c) 2006, 2007, 2008 Ciaran McCreesh
 *
 * 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_DEP_ATOM_FLATTENER_HH
#define PALUDIS_GUARD_PALUDIS_DEP_ATOM_FLATTENER_HH 1

#include <paludis/environment-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/dep_spec-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/tr1_memory.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/no_type.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <paludis/util/sr.hh>

/** \file
 * Declarations for DepSpecFlattener.
 *
 * \ingroup g_dep_spec
 *
 * \section Examples
 *
 * - \ref example_dep_spec_flattener.cc "example_dep_spec_flattener.cc"
 */

namespace paludis
{
    /** \namespace dep_spec_flattener_internals
     *
     * For internal use by DepSpecFlattener.
     *
     * \ingroup g_dep_spec
     * \since 0.26
     */
    namespace dep_spec_flattener_internals
    {
        /**
         * Implement visit for NamedSetDepSpec, if necessary.
         *
         * \ingroup g_dep_spec
         * \since 0.26
         * \nosubgrouping
         */
        template <typename H_, typename I_, bool b_>
        struct VisitNamedSetDepSpec
        {
            void visit_leaf(const NoType<0u> &);
        };

        /**
         * Implement visit for NamedSetDepSpec, if necessary.
         *
         * \ingroup g_dep_spec
         * \since 0.26
         * \nosubgrouping
         */
        template <typename H_, typename I_>
        class VisitNamedSetDepSpec<H_, I_, true> :
            public virtual visitor_internals::Visits<const TreeLeaf<H_, NamedSetDepSpec> >,
            private PrivateImplementationPattern<VisitNamedSetDepSpec<H_, I_, true> >
        {
            private:
                using PrivateImplementationPattern<VisitNamedSetDepSpec<H_, I_, true> >::_imp;

            protected:
                VisitNamedSetDepSpec();
                ~VisitNamedSetDepSpec();

            public:
                void visit_leaf(const NamedSetDepSpec &);
        };

        /**
         * Implement visit for ConditionalDepSpec, if necessary.
         *
         * \ingroup g_dep_spec
         * \since 0.26
         * \nosubgrouping
         */
        template <typename H_, typename I_, bool b_>
        struct VisitConditionalDepSpec
        {
            void visit_sequence(const NoType<0u> &);
        };

        /**
         * Implement visit for ConditionalDepSpec, if necessary.
         *
         * \ingroup g_dep_spec
         * \since 0.26
         * \nosubgrouping
         */
        template <typename H_, typename I_>
        struct VisitConditionalDepSpec<H_, I_, true> :
            virtual visitor_internals::Visits<const ConstTreeSequence<H_, ConditionalDepSpec> >
        {
            void visit_sequence(
                    const ConditionalDepSpec &,
                    typename H_::ConstSequenceIterator,
                    typename H_::ConstSequenceIterator);
        };
    }

    /**
     * Extract the enabled components of a dep heirarchy for a particular
     * package. Sets, via NamedSetDepSpec, are automatically expanded.
     *
     * This template can be instantiated as:
     *
     * - DepSpecFlattener<ProvideSpecTree, PlainTextDepSpec>
     * - DepSpecFlattener<RestrictSpecTree, PlainTextDepSpec>
     * - DepSpecFlattener<SetSpecTree, PackageDepSpec>
     * - DepSpecFlattener<SimpleURISpecTree, SimpleURIDepSpec>
     *
     * It is <b>not</b> suitable for heirarchies that can contain AnyDepSpec
     * or any kind of label.
     *
     * \ingroup g_dep_spec
     * \since 0.26
     * \nosubgrouping
     */
    template <typename Heirarchy_, typename Item_>
    class PALUDIS_VISIBLE DepSpecFlattener :
        private InstantiationPolicy<DepSpecFlattener<Heirarchy_, Item_>, instantiation_method::NonCopyableTag>,
        private PrivateImplementationPattern<DepSpecFlattener<Heirarchy_, Item_> >,
        public ConstVisitor<Heirarchy_>,
        public ConstVisitor<Heirarchy_>::template VisitConstSequence<DepSpecFlattener<Heirarchy_, Item_>, AllDepSpec>,
        public dep_spec_flattener_internals::VisitNamedSetDepSpec<
            Heirarchy_, Item_, ConstVisitor<Heirarchy_>::template Contains<const TreeLeaf<Heirarchy_, NamedSetDepSpec> >::value>,
        public dep_spec_flattener_internals::VisitConditionalDepSpec<
            Heirarchy_, Item_, ConstVisitor<Heirarchy_>::template Contains<const ConstTreeSequence<Heirarchy_, ConditionalDepSpec> >::value>
    {
        friend class dep_spec_flattener_internals::VisitNamedSetDepSpec<
            Heirarchy_, Item_, ConstVisitor<Heirarchy_>::template Contains<const TreeLeaf<Heirarchy_, NamedSetDepSpec> >::value>;
        friend class dep_spec_flattener_internals::VisitConditionalDepSpec<
            Heirarchy_, Item_, ConstVisitor<Heirarchy_>::template Contains<const ConstTreeSequence<Heirarchy_, ConditionalDepSpec> >::value>;

        private:
            typename PrivateImplementationPattern<DepSpecFlattener<Heirarchy_, Item_> >::ImpPtr & _imp;

        public:
            ///\name Visit methods
            ///{

            using ConstVisitor<Heirarchy_>::template VisitConstSequence<DepSpecFlattener<Heirarchy_, Item_>, AllDepSpec>::visit_sequence;

            using dep_spec_flattener_internals::VisitConditionalDepSpec<Heirarchy_, Item_,
                  ConstVisitor<Heirarchy_>::template Contains<const ConstTreeSequence<Heirarchy_, ConditionalDepSpec> >::value>::visit_sequence;

            using dep_spec_flattener_internals::VisitNamedSetDepSpec<Heirarchy_, Item_,
                ConstVisitor<Heirarchy_>::template Contains<const TreeLeaf<Heirarchy_, NamedSetDepSpec> >::value>::visit_leaf;

            void visit_leaf(const Item_ &);

            ///}

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

            DepSpecFlattener(const Environment * const);

            ~DepSpecFlattener();

            ///\}

            ///\name Iterate over our dep specs
            ///\{

            struct ConstIteratorTag;
            typedef WrappedForwardIterator<ConstIteratorTag, const tr1::shared_ptr<const Item_> > ConstIterator;

            ConstIterator begin() const;
            ConstIterator end() const;

            ///\}
    };
}

#endif