aboutsummaryrefslogtreecommitdiff
path: root/0.8.0/paludis/args/args_group.hh
blob: 62b363d16212df3b3edabfe42ae942891eb4816a (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 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_ARGS_ARGS_GROUP_HH
#define PALUDIS_GUARD_ARGS_ARGS_GROUP_HH 1

#include <paludis/args/args_option.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <string>

#include <libwrapiter/libwrapiter_forward_iterator.hh>

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

namespace paludis
{

    namespace args
    {
        class ArgsHandler;

        /**
         * Contains a related group of command line arguments.
         *
         * \ingroup grplibpaludisargs
         */
        class PALUDIS_VISIBLE ArgsGroup :
            private PrivateImplementationPattern<ArgsGroup>,
            private InstantiationPolicy<ArgsGroup, instantiation_method::NonCopyableTag>
        {
            private:
                const std::string _name;
                const std::string _description;

                ArgsHandler * _handler;

            public:
                ArgsHandler * handler()
                {
                    return _handler;
                }

                /**
                 * Add an ArgsOption instance (called by the ArgsOption
                 * constructor).
                 */
                void add(ArgsOption * const value);

                ///\name Iterate over our ArgsOptions.
                ///\{

                typedef libwrapiter::ForwardIterator<ArgsGroup, ArgsOption * const> Iterator;

                Iterator begin() const;
                Iterator end() const;

                ///\}

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

                ArgsGroup(ArgsHandler * h, const std::string & name,
                        const std::string & description);

                ~ArgsGroup();

                ///\}

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

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

                /**
                 * Fetch our handler.
                 */
                ArgsHandler * handler() const
                {
                    return _handler;
                }
        };
    }
}

#endif