aboutsummaryrefslogtreecommitdiff
path: root/paludis/default_config.hh
blob: 45e995d4d0b1ff4c8155f4f4abf86d680e1791fc (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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006 Ciaran McCreesh <ciaranm@ciaranm.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_DEFAULT_CONFIG_HH
#define PALUDIS_GUARD_PALUDIS_DEFAULT_CONFIG_HH 1

#include <paludis/dep_atom.hh>
#include <paludis/name.hh>
#include <paludis/util/collection.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/sr.hh>

#include <string>

/** \file
 * Declarations for the DefaultConfig class and related utilities.
 *
 * \ingroup grpdefaultconfig
 */

namespace paludis
{
    struct EnvironmentMirrorIteratorTag;

    typedef libwrapiter::ForwardIterator<EnvironmentMirrorIteratorTag,
            const std::pair<const std::string, std::string> > EnvironmentMirrorIterator;

    /**
     * A DefaultConfigError is thrown if a configuration error is encountered
     * by DefaultConfig.
     *
     * \ingroup grpexceptions
     * \ingroup grpdefaultconfig
     */
    class DefaultConfigError : public ConfigurationError
    {
        public:
            /**
             * Constructor.
             */
            DefaultConfigError(const std::string & msg) throw ();
    };

#include <paludis/repository_config_entry-sr.hh>
#include <paludis/use_config_entry-sr.hh>

    /**
     * DefaultConfig is used by DefaultEnvironment to access the user's
     * configuration settings from on-disk configuration files.
     *
     * \ingroup grpdefaultconfig
     */
    class DefaultConfig :
        public InstantiationPolicy<DefaultConfig, instantiation_method::SingletonAsNeededTag>,
        private PrivateImplementationPattern<DefaultConfig>
    {
        friend class InstantiationPolicy<DefaultConfig, instantiation_method::SingletonAsNeededTag>;

        private:
            DefaultConfig();

            ~DefaultConfig();

        public:
            /**
             * Set config suffix. Must be called before we do anything, or not
             * at all.
             */
            static void set_config_suffix(const std::string &);

            /**
             * Get config suffix.
             */
            static std::string config_suffix();

            ///\name Iterate over our repositories
            ///{

            typedef libwrapiter::ForwardIterator<DefaultConfig, const RepositoryConfigEntry> RepositoryIterator;

            RepositoryIterator begin_repositories() const;

            RepositoryIterator end_repositories() const;

            ///}

            ///\name Iterate over our default and per-package keywords
            ///{

            typedef libwrapiter::ForwardIterator<DefaultConfig,
                    const std::pair<PackageDepAtom::ConstPointer, KeywordName> > PackageKeywordsIterator;

            PackageKeywordsIterator begin_package_keywords(const QualifiedPackageName & d) const;

            PackageKeywordsIterator end_package_keywords(const QualifiedPackageName & d) const;

            typedef libwrapiter::ForwardIterator<DefaultConfig, const KeywordName> DefaultKeywordsIterator;

            DefaultKeywordsIterator begin_default_keywords() const;

            DefaultKeywordsIterator end_default_keywords() const;

            ///}

            ///\name Iterate over our default and per-package licenses
            ///{

            typedef libwrapiter::ForwardIterator<DefaultConfig,
                    const std::pair<PackageDepAtom::ConstPointer, std::string> > PackageLicensesIterator;

            PackageLicensesIterator begin_package_licenses(const QualifiedPackageName & d) const;

            PackageLicensesIterator end_package_licenses(const QualifiedPackageName & d) const;

            typedef libwrapiter::ForwardIterator<DefaultConfig, const std::string> DefaultLicensesIterator;

            DefaultLicensesIterator begin_default_licenses() const;

            DefaultLicensesIterator end_default_licenses() const;

            ///}

            ///\name Iterate over our masks and unmasks
            ///{

            typedef libwrapiter::ForwardIterator<DefaultConfig, const PackageDepAtom> UserMasksIterator;

            UserMasksIterator begin_user_masks(const QualifiedPackageName & d) const;

            UserMasksIterator end_user_masks(const QualifiedPackageName & d) const;

            typedef libwrapiter::ForwardIterator<DefaultConfig, const PackageDepAtom> UserUnmasksIterator;

            UserUnmasksIterator begin_user_unmasks(const QualifiedPackageName & d) const;

            UserUnmasksIterator end_user_unmasks(const QualifiedPackageName & d) const;

            ///}

            ///\name Iterate over our default and per-package use flags
            ///{

            typedef libwrapiter::ForwardIterator<DefaultConfig, const UseConfigEntry> UseConfigIterator;

            UseConfigIterator begin_use_config(const QualifiedPackageName & q) const;

            UseConfigIterator end_use_config(const QualifiedPackageName & q) const;

            typedef libwrapiter::ForwardIterator<DefaultConfig,
                    const std::pair<UseFlagName, UseFlagState> > DefaultUseIterator;

            DefaultUseIterator begin_default_use() const;

            DefaultUseIterator end_default_use() const;

            typedef libwrapiter::ForwardIterator<DefaultConfig, const std::string> UseMinusStarIterator;

            UseMinusStarIterator begin_use_prefixes_with_minus_star() const;
            UseMinusStarIterator end_use_prefixes_with_minus_star() const;

            typedef libwrapiter::ForwardIterator<DefaultConfig,
                    const std::pair<PackageDepAtom::ConstPointer, std::string> > PackageUseMinusStarIterator;

            PackageUseMinusStarIterator begin_package_use_prefixes_with_minus_star(const QualifiedPackageName &) const;
            PackageUseMinusStarIterator end_package_use_prefixes_with_minus_star(const QualifiedPackageName &) const;

            ///}

            /**
             * Our bashrc files.
             */
            std::string bashrc_files() const;

            /**
             * The paludis command.
             */
            std::string paludis_command() const;

            /**
             * Set the paludis command.
             */
            void set_paludis_command(const std::string & s);

            /**
             * The ROOT.
             */
            std::string root() const;

            /**
             * The config directory.
             */
            std::string config_dir() const;

            ///\name Iterate over our mirrors
            ///\{

            typedef EnvironmentMirrorIterator MirrorIterator;

            MirrorIterator begin_mirrors(const std::string & m) const;

            MirrorIterator end_mirrors(const std::string & m) const;

            ///\}
    };
}

#endif