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

/*
 * Copyright (c) 2005, 2006, 2007, 2008, 2009 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_REPOSITORIES_E_E_REPOSITORY_PROFILE_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_E_E_REPOSITORY_PROFILE_HH 1

#include <paludis/dep_spec-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/name.hh>
#include <paludis/version_spec-fwd.hh>
#include <paludis/mask-fwd.hh>
#include <paludis/metadata_key-fwd.hh>
#include <paludis/choice-fwd.hh>
#include <paludis/spec_tree-fwd.hh>
#include <paludis/util/fs_entry.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/tribool.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <paludis/util/mutex-fwd.hh>
#include <paludis/util/named_value.hh>
#include <paludis/repositories/e/e_repository_id.hh>
#include <string>

/** \file
 * Declaration for the ERepositoryProfile class.
 *
 * \ingroup grperepository
 */

namespace paludis
{
    class Environment;
    class ERepository;

    namespace n
    {
        struct arch_var_if_special;
        struct environment;
        struct location;
        struct mutex;
        struct profiles_explicitly_set;
        struct repository;
        struct repository_name;
        struct value;
    }

    class ERepositoryProfile;

    struct PALUDIS_VISIBLE RepositoryEInterfaceProfilesDescLineProfile
    {
        NamedValue<n::arch_var_if_special, std::string> arch_var_if_special;
        NamedValue<n::environment, const Environment *> environment;
        NamedValue<n::location, std::tr1::shared_ptr<const FSEntrySequence> > location;
        NamedValue<n::mutex, std::tr1::shared_ptr<Mutex> > mutex;
        NamedValue<n::profiles_explicitly_set, bool> profiles_explicitly_set;
        NamedValue<n::repository, const ERepository *> repository;
        NamedValue<n::repository_name, RepositoryName> repository_name;
        mutable NamedValue<n::value, std::tr1::shared_ptr<ERepositoryProfile> > value;

        const std::tr1::shared_ptr<ERepositoryProfile> fetch() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * Holds the profile data (but <em>not</em> the profiles/ top level data) for
     * a ERepository instance.
     *
     * \ingroup grperepository
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE ERepositoryProfile :
        private PrivateImplementationPattern<ERepositoryProfile>,
        private InstantiationPolicy<ERepositoryProfile, instantiation_method::NonCopyableTag>
    {
        public:
            ///\name Basic operations
            ///\{

            ERepositoryProfile(const Environment * const env,
                    const ERepository * const,
                    const RepositoryName & name,
                    const FSEntrySequence & location,
                    const std::string & arch_var_if_special,
                    const bool profiles_explicitly_set);
            ~ERepositoryProfile();

            ///\}

            ///\name Use flag queries
            ///\{

            /// Is a use flag masked?
            bool use_masked(
                    const std::tr1::shared_ptr<const PackageID> &,
                    const std::tr1::shared_ptr<const Choice> &,
                    const UnprefixedChoiceName & value_unprefixed,
                    const ChoiceNameWithPrefix & value_prefixed
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            /// Is a use flag forced?
            bool use_forced(
                    const std::tr1::shared_ptr<const PackageID> &,
                    const std::tr1::shared_ptr<const Choice> &,
                    const UnprefixedChoiceName & value_unprefixed,
                    const ChoiceNameWithPrefix & value_prefixed
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            /// Use flag state, ignoring mask and force?
            Tribool use_state_ignoring_masks(
                    const std::tr1::shared_ptr<const PackageID> &,
                    const std::tr1::shared_ptr<const Choice> &,
                    const UnprefixedChoiceName & value_unprefixed,
                    const ChoiceNameWithPrefix & value_prefixed
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            std::tr1::shared_ptr<const Set<UnprefixedChoiceName> > known_choice_value_names(
                    const std::tr1::shared_ptr<const erepository::ERepositoryID> &,
                    const std::tr1::shared_ptr<const Choice> &
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}

            ///\name Iterate over USE_EXPAND, USE_EXPAND_HIDDEN etc
            ///\{

            const std::tr1::shared_ptr<const Set<std::string> > use_expand() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::tr1::shared_ptr<const Set<std::string> > use_expand_hidden() const PALUDIS_ATTRIBUTE((warn_unused_result));

            const std::tr1::shared_ptr<const Set<std::string> > use_expand_unprefixed() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::tr1::shared_ptr<const Set<std::string> > use_expand_implicit() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::tr1::shared_ptr<const Set<std::string> > iuse_implicit() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::tr1::shared_ptr<const Set<std::string> > use_expand_values(const std::string &) const PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}

            ///\name Environment variable queries
            ///\{

            /// What is the value of an environment variable?
            std::string environment_variable(const std::string &) const;

            ///\}

            ///\name Masks
            ///\{

            std::tr1::shared_ptr<const RepositoryMaskInfo> profile_masked(const PackageID &) const;

            ///\}

            ///\name System package set
            ///\{

            const std::tr1::shared_ptr<const SetSpecTree> system_packages() const;

            ///\}

            ///\name Virtuals
            ///\{

            struct VirtualsConstIteratorTag;
            typedef WrappedForwardIterator<VirtualsConstIteratorTag,
                const std::pair<const QualifiedPackageName, std::tr1::shared_ptr<const PackageDepSpec> > > VirtualsConstIterator;

            VirtualsConstIterator begin_virtuals() const;
            VirtualsConstIterator end_virtuals() const;
            VirtualsConstIterator find_virtual(const QualifiedPackageName &) const;

            ///\}
    };
}

#endif