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

/*
 * Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 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/spec_tree.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/no_type.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <memory>
#include <type_traits>

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

namespace paludis
{
    /**
     * 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<PlainTextSpecTree, PlainTextDepSpec>
     * - DepSpecFlattener<SetSpecTree, PackageDepSpec>
     * - DepSpecFlattener<SimpleURISpecTree, SimpleURIDepSpec>
     *
     * It is <b>not</b> suitable for heirarchies that can contain AnyDepSpec.
     * Any labels are discarded.
     *
     * \ingroup g_dep_spec
     * \since 0.26
     * \nosubgrouping
     */
    template <typename Heirarchy_, typename Item_>
    class PALUDIS_VISIBLE DepSpecFlattener
    {
        private:
            Pimp<DepSpecFlattener<Heirarchy_, Item_> > _imp;

        public:
            ///\name Visit operations
            ///\{

            void visit(const typename Heirarchy_::template NodeType<NamedSetDepSpec>::Type & node);
            void visit(const typename Heirarchy_::template NodeType<PlainTextDepSpec>::Type & node);
            void visit(const typename Heirarchy_::template NodeType<PackageDepSpec>::Type & node);
            void visit(const typename Heirarchy_::template NodeType<SimpleURIDepSpec>::Type & node);
            void visit(const typename Heirarchy_::template NodeType<PlainTextLabelDepSpec>::Type & node);

            void visit(const typename Heirarchy_::template NodeType<AllDepSpec>::Type & node);
            void visit(const typename Heirarchy_::template NodeType<AnyDepSpec>::Type & node);
            void visit(const typename Heirarchy_::template NodeType<ConditionalDepSpec>::Type & node);

            ///\}

            ///\name Visit implementation operations

            template <bool b_> void handle_named_set(const NamedSetDepSpec & spec);
            void handle_item(const Item_ & spec);

            ///\}

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

            DepSpecFlattener(
                    const Environment * const,
                    const std::shared_ptr<const PackageID> & = typename std::enable_if<
                        std::is_same<Heirarchy_, SetSpecTree>::value,
                        std::shared_ptr<const PackageID> >::type());

            ~DepSpecFlattener();

            DepSpecFlattener(const DepSpecFlattener &) = delete;

            DepSpecFlattener & operator= (const DepSpecFlattener &) = delete;

            ///\}

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

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

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

            ///\}
    };

    extern template class PALUDIS_VISIBLE DepSpecFlattener<PlainTextSpecTree, PlainTextDepSpec>;
    extern template class PALUDIS_VISIBLE DepSpecFlattener<SetSpecTree, PackageDepSpec>;
    extern template class PALUDIS_VISIBLE DepSpecFlattener<SimpleURISpecTree, SimpleURIDepSpec>;

    extern template class PALUDIS_VISIBLE WrappedForwardIterator<DepSpecFlattener<PlainTextSpecTree, PlainTextDepSpec>::ConstIteratorTag,
           const std::shared_ptr<const PlainTextDepSpec> >;
    extern template class PALUDIS_VISIBLE WrappedForwardIterator<DepSpecFlattener<SetSpecTree, PackageDepSpec>::ConstIteratorTag,
           const std::shared_ptr<const PackageDepSpec> >;
    extern template class PALUDIS_VISIBLE WrappedForwardIterator<DepSpecFlattener<SimpleURISpecTree, SimpleURIDepSpec>::ConstIteratorTag,
           const std::shared_ptr<const SimpleURIDepSpec> >;
}

#endif