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

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

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

/** \file
 * Declarations for ArgsGroup.
 *
 * \ingroup g_args
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{

    namespace args
    {
        class ArgsSection;

        /**
         * Contains a related group of command line arguments.
         *
         * \ingroup g_args
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE ArgsGroup
        {
            private:
                Pimp<ArgsGroup> _imp;

                const std::string _name;
                const std::string _description;

                ArgsSection * _section;

            public:
                /**
                 * Remove this group from our section.
                 */
                void remove();

                /**
                 * Fetch our section.
                 */
                ArgsSection * section() const
                {
                    return _section;
                }

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

                /**
                 * Remove an ArgsOption instance (called by
                 * ArgsOption::remove).  Calls ArgsGroup::remove() if
                 * that would leave us with no ArgsOptions.
                 */
                void remove(ArgsOption * const value);

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

                struct ConstIteratorTag;
                typedef WrappedForwardIterator<ConstIteratorTag, ArgsOption * const> ConstIterator;

                ConstIterator begin() const;
                ConstIterator end() const;

                ///\}

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

                ArgsGroup(ArgsSection * s, const std::string & name,
                        const std::string & description);

                ~ArgsGroup();

                ArgsGroup(const ArgsGroup &) = delete;
                ArgsGroup & operator= (const ArgsGroup &) = delete;

                ///\}

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

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

    extern template class PALUDIS_VISIBLE WrappedForwardIterator<args::ArgsGroup::ConstIteratorTag, args::ArgsOption * const>;
}

#endif