aboutsummaryrefslogtreecommitdiff
path: root/paludis/util/config_file.hh
blob: 1b2d69585ae21caf8f87499dc518077d64440490 (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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
/* 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_CONFIG_FILE_HH
#define PALUDIS_GUARD_PALUDIS_CONFIG_FILE_HH 1

#include <paludis/util/config_file-fwd.hh>
#include <paludis/util/map-fwd.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/options-fwd.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <paludis/util/fs_path-fwd.hh>

#include <iosfwd>
#include <string>
#include <memory>
#include <functional>

/** \file
 * Declarations for the ConfigFile classes.
 *
 * \ingroup g_config_file
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    /**
     * Raised if an error is encountered parsing a configuration file.
     *
     * \ingroup g_config_file
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE ConfigFileError :
        public ConfigurationError
    {
        public:
            ///\name Basic operations
            ///\{

            /**
             * Constructor, where the filename is known.
             *
             * \param filename The filename in which the error occurred. May be a blank string, if
             *   the filename is not necessarily known.
             * \param message A description of the error.
             */
            ConfigFileError(const std::string & filename, const std::string & message) throw ();

            /**
             * Constructor, where the filename is not known.
             *
             * \param message A description of the error.
             */
            ConfigFileError(const std::string & message) throw ();

            ///\}
    };

    /**
     * Base class for configuration files.
     *
     * Data is read in from a ConfigFile::Source instance, which can be created from
     * an FSPath, a std::istream or a string.
     *
     * \see KeyValueConfigFile
     * \see LineConfigFile
     *
     * \ingroup g_config_file
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE ConfigFile
    {
        public:
            /**
             * A source (for example, a file or a string) usable by ConfigFile.
             *
             * \see ConfigFile
             * \ingroup g_config_file
             * \nosubgrouping
             */
            class PALUDIS_VISIBLE Source
            {
                private:
                    Pimp<Source> _imp;

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

                    Source(const FSPath &);
                    Source(const std::string &);
                    Source(std::istream &);

                    Source(const Source &);
                    const Source & operator= (const Source &);

                    ~Source();

                    ///\}

                    /**
                     * Our text, for use by ConfigFile.
                     */
                    const std::string & text() const PALUDIS_ATTRIBUTE((warn_unused_result));

                    /**
                     * Our filename (may be empty), for use by ConfigFile.
                     */
                    const std::string & filename() const PALUDIS_ATTRIBUTE((warn_unused_result));
            };

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

            virtual ~ConfigFile() = 0;

            ///\}
    };

    /**
     * A line-based configuration file.
     *
     * Various syntax options are available, and are controlled by LineConfigFileOptions:
     *
     * - Unless lcfo_disallow_continuations, lines ending in a backslash are continuations
     * - Unless lcfo_disallow_comments, lines starting with a \# are comments
     * - Unless lcfo_preserve_whitespace, leading and trailing whitespace is stripped
     * - Unless lcfo_no_skip_blank_lines, blank lines are skipped.
     *
     * \ingroup g_config_file
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE LineConfigFile :
        public ConfigFile
    {
        private:
            Pimp<LineConfigFile> _imp;

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

            LineConfigFile(const Source &, const LineConfigFileOptions &);

            ~LineConfigFile();

            ///\}

            ///\name Iterate over our lines
            ///\{

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

            ConstIterator begin() const PALUDIS_ATTRIBUTE((warn_unused_result));
            ConstIterator end() const PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}
    };

    /**
     * A key=value configuration file.
     *
     * Various syntax options are available, and are controlled by KeyValueConfigFileOptions:
     *
     * - Unless kvcfo_disallow_continuations, line continuations via backslashes are allowed.
     * - Unless kvcfo_disallow_comments, comments start with a \#.
     * - Unless kvcfo_disallow_space_around_equals, the equals sign can have surrounding whitespace.
     * - Unless kvcfo_disallow_space_inside_unquoted_values, foo = bar baz is legal.
     * - Unless kvcfo_disallow_single_quoted_strings, single quoted strings are legal.
     * - Unless kvcfo_disallow_double_quoted_strings, double quoted strings are legal.
     * - Unless kvcfo_disallow_unquoted_values, unquoted values are legal.
     * - Unless kvcfo_disallow_variables, variables using $foo and ${foo} are expanded.
     * - Unless kvcfo_disallow_source, source path is legal.
     * - Unless kvcfo_preserve_whitespace, leading and trailing whitespace on values is stripped.
     * - If kvcfo_allow_sections, sections in the form "[foo]" and "[foo bar]" are allowed. A key
     *       'baz' in section "[foo]" will be treated as "foo/baz", and "[foo bar]" as "foo/bar/baz".
     *
     * \ingroup g_config_file
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE KeyValueConfigFile :
        public ConfigFile
    {
        private:
            Pimp<KeyValueConfigFile> _imp;

        public:
            typedef std::function<std::string (const KeyValueConfigFile &, const std::string &)> DefaultFunction;
            typedef std::function<std::string (const KeyValueConfigFile &,
                    const std::string & var, const std::string & old_value, const std::string & new_value)> TransformationFunction;

            static std::string no_defaults(const KeyValueConfigFile &, const std::string &);
            static std::string no_transformation(const KeyValueConfigFile &, const std::string &, const std::string &, const std::string &);

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

            /**
             * Constructor.
             *
             * \since 0.28
             */
            KeyValueConfigFile(
                    const Source &,
                    const KeyValueConfigFileOptions &,
                    const DefaultFunction &,
                    const TransformationFunction &
                    );

            ~KeyValueConfigFile();

            ///\}

            ///\name Iterate over our keys
            ///\{

            struct ConstIteratorTag;
            typedef WrappedForwardIterator<ConstIteratorTag,
                    const std::pair<const std::string, std::string> > ConstIterator;
            ConstIterator begin() const PALUDIS_ATTRIBUTE((warn_unused_result));
            ConstIterator end() const PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}

            /**
             * Fetch the value for a particular key.
             */
            std::string get(const std::string &) const PALUDIS_ATTRIBUTE((warn_unused_result));

            const KeyValueConfigFileOptions & options() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const DefaultFunction & default_function() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const TransformationFunction & transformation_function() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    extern template class Pimp<ConfigFile::Source>;
    extern template class Pimp<LineConfigFile>;
    extern template class Pimp<KeyValueConfigFile>;

    extern template class PALUDIS_VISIBLE WrappedForwardIterator<LineConfigFile::ConstIteratorTag, const std::string>;
    extern template class PALUDIS_VISIBLE WrappedForwardIterator<KeyValueConfigFile::ConstIteratorTag, const std::pair<const std::string, std::string> >;
}

#endif