aboutsummaryrefslogtreecommitdiff
path: root/0.4.0/paludis/args/args_option.hh
blob: bce3c863b908cd9ff58428ea302e1d38569a9fd9 (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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
 * Copyright (c) 2006 Stephen Bennett <spb@gentoo.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_ARGS_ARGS_OPTION_HH
#define PALUDIS_GUARD_ARGS_ARGS_OPTION_HH 1

#include <paludis/args/args_visitor.hh>
#include <set>
#include <string>
#include <vector>

/** \file
 * Declaration for ArgsOption.
 *
 * \ingroup grplibpaludisargs
 */

namespace paludis
{
    namespace args
    {
        class ArgsGroup;

        /**
         * Base class for a command line option.
         *
         * \ingroup grplibpaludisargs
         */
        class ArgsOption : public virtual VisitableInterface<ArgsVisitorTypes>
        {
            friend class ArgsHandler;

            private:
                ArgsGroup * const _group;

                const std::string _long_name;
                const char _short_name;
                const std::string _description;

                bool _specified;

                ArgsOption(const ArgsOption &);

                void operator= (const ArgsOption &);

            protected:
                /**
                 * Constructor.
                 */
                ArgsOption(ArgsGroup * const, const std::string & long_name,
                        const char short_name, const std::string & description);

                /**
                 * Destructor.
                 */
                ~ArgsOption();

            public:
                /**
                 * Fetch our long name.
                 */
                const std::string & long_name() const
                {
                    return _long_name;
                }

                /**
                 * Fetch our short name (may be 0).
                 */
                char short_name() const
                {
                    return _short_name;
                }

                /**
                 * Fetch our description.
                 */
                const std::string & description() const
                {
                    return _description;
                }

                /**
                 * Fetch whether or not we were specified on the
                 * command line.
                 */
                virtual bool specified() const
                {
                    return _specified;
                }

                /**
                 * Set the value returned by specified().
                 */
                virtual void set_specified(const bool value)
                {
                    _specified = value;
                }

                /**
                 * Fetch our group.
                 */
                ArgsGroup * group()
                {
                    return _group;
                }
        };
 
        /**
         * A SwitchArg is an option that can either be specified or not
         * specified, and that takes no value (for example, --help).
         *
         * \ingroup grplibpaludisargs
         */
        class SwitchArg : public ArgsOption, public Visitable<SwitchArg, ArgsVisitorTypes>
        {
            public:
                /**
                 * Constructor.
                 */
                SwitchArg(ArgsGroup * const group, std::string long_name, char short_name,
                        std::string description);

                ~SwitchArg();
        };
 
        /**
         * An option that takes a string argument.
         *
         * \ingroup grplibpaludisargs
         */
        class StringArg : public ArgsOption, public Visitable<StringArg, ArgsVisitorTypes>
        {
            private:
                std::string _argument;

            public:

                /**
                * Constructor
                */
                StringArg(ArgsGroup * const, const std::string & long_name,
                       const char short_name, const std::string & description);

                /**
                 * Fetch the argument that was given to this option.
                 */
                const std::string& argument() const { return _argument; }

                /**
                 * Set the argument returned by argument().
                 */
                void set_argument(const std::string& arg) { _argument = arg; }
        };

        /**
         * An option that takes a set of strings.
         *
         * \ingroup grplibpaludisargs
         */
        class StringSetArg : public ArgsOption, public Visitable<StringSetArg, ArgsVisitorTypes>
        {
            private:
                std::set<std::string> _args;

            public:

                /**
                 * Type used to iterate over specified args.
                 */
                typedef std::set<std::string>::const_iterator Iterator;

                /**
                 * Constructor
                 */
                StringSetArg(ArgsGroup * const, const std::string & long_name,
                        const char short_name, const std::string & description);

                /**
                 * Retrieve an iterator to the first arg
                 */
                Iterator args_begin() const { return _args.begin(); }

                /**
                 * Retrieve an iterator one past the last arg
                 */
                Iterator args_end() const { return _args.end(); }

                /**
                 * Add an argument to the set returned by [ args_begin(), args_end() )
                 */
                void add_argument(const std::string & arg) { _args.insert(arg); }
        };


        /**
         * An AliasArg is an alias for another argument.
         *
         * \ingroup grplibpaludisargs
         */
        class AliasArg : public ArgsOption, public Visitable<AliasArg, ArgsVisitorTypes>
        {
            private:
                ArgsOption * const _other;

            public:
                /**
                 * Constructor.
                 */
                AliasArg(ArgsOption * const other, const std::string & new_long_name);

                virtual bool specified() const
                {
                    return _other->specified();
                }

                virtual void set_specified(const bool value)
                {
                    _other->set_specified(value);
                }
        };
 
        /**
         * An option that takes an integer argument.
         *
         * \ingroup grplibpaludisargs
         */
        class IntegerArg : public ArgsOption, public Visitable<IntegerArg, ArgsVisitorTypes>
        {
            private:
                int _argument;

            public:
                /**
                 * Constructor
                 */
                IntegerArg(ArgsGroup * const, const std::string & long_name,
                        const char short_name, const std::string & description);
                /**
                 * Fetch the argument that was given to this option.
                 */
                int argument() const { return _argument; }

                /**
                 * Set the argument returned by argument().
                 */
                void set_argument(const int arg) { _argument = arg; }
        };

        /**
         * An option that takes one of a predefined set of string arguments.
         *
         * \ingroup grplibpaludisargs
         */
        class EnumArg : public ArgsOption, public Visitable<EnumArg, ArgsVisitorTypes>
        {
            private:
                const std::vector<std::pair<std::string, std::string> > _allowed_args;
                std::string _argument;
                const std::string _default_arg;

            public:

                /**
                 * Helper class for passing available options and associated descriptions
                 * to the EnumArg constructor.
                 *
                 * \ingroup grplibpaludisargs
                 */
                class EnumArgOptions
                {
                    private:
                        friend class EnumArg;
                        std::vector<std::pair<std::string, std::string> > _options;

                    public:
                        /**
                         * Constructor
                         */
                        EnumArgOptions(const std::string, const std::string);

                        /**
                         * Destructor.
                         */
                        ~EnumArgOptions();

                        /**
                         * Adds another (option, description) pair.
                         */
                        EnumArgOptions& operator() (const std::string, const std::string);
                };

                /**
                 * Constructor.
                 */
                EnumArg(ArgsGroup * const group, const std::string & long_name,
                        const char short_name, const std::string & description,
                        const EnumArgOptions & opts, const std::string & default_arg) :
                    ArgsOption(group, long_name, short_name, description),
                    _allowed_args(opts._options), _argument(default_arg), 
                    _default_arg(default_arg)
                {
                }

                ~EnumArg();

                /**
                 * Fetch the argument that was given to this option.
                 */
                const std::string & argument() const { return _argument; }

                /**
                 * Set the argument returned by argument(), having verified that
                 * it is one of the arguments allowed for this option.
                 */
                void set_argument(const std::string & arg);

                /**
                 * Fetch the default option, as specified to the constructor.
                 */
                const std::string & default_arg() const { return _default_arg; }

                /**
                 * Type used to iterate over valid arguments to this option
                 */
                typedef std::vector<std::pair<std::string, std::string> >::const_iterator AllowedArgIterator;

                /**
                 * Returns an iterator pointing to a pair containing the first valid argument,
                 * and its description.
                 */
                AllowedArgIterator begin_allowed_args() const { return _allowed_args.begin(); }

                /**
                 * Returns an iterator pointing just beyond the last valid argument.
                 */
                AllowedArgIterator end_allowed_args() const { return _allowed_args.end(); }
        };
    }
}

#endif