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

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
 *
 * 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_HANDLER_HH
#define PALUDIS_GUARD_ARGS_ARGS_HANDLER_HH 1

#include <map>
#include <ostream>
#include <paludis/args/args_group.hh>
#include <paludis/util/instantiation_policy.hh>
#include <string>

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

namespace paludis
{
    namespace args
    {
        /**
         * Handles command line arguments.
         *
         * \ingroup grplibpaludisargs
         */
        class ArgsHandler : private InstantiationPolicy<ArgsHandler, instantiation_method::NonCopyableTag>
        {
            friend class ArgsGroup;
            friend std::ostream & operator<< (std::ostream &, const ArgsHandler &);

            private:
                std::list<ArgsGroup *> _groups;
                std::list<std::string> _parameters;

                std::map<std::string, ArgsOption *> _longopts;
                std::map<char, ArgsOption *> _shortopts;

            protected:
                /**
                 * Add an new ArgsGroup (called by the ArgsGroup constructor).
                 */
                void add(ArgsGroup * const);

                /**
                 * Dump, for --help output (called by operator<<).
                 */
                void dump_to_stream(std::ostream & s) const;

            public:
                /**
                 * Constructor.
                 */
                ArgsHandler();

                /**
                 * Parse command line arguments.
                 */
                void run(const int, const char * const * const);

                /**
                 * Iterate over our parameters (non - and -- switches and their
                 * values).
                 */
                typedef std::list<std::string>::const_iterator ParametersIterator;

                /**
                 * Pointer to the start of our parameters.
                 */
                ParametersIterator begin_parameters() const
                {
                    return _parameters.begin();
                }

                /**
                 * Pointer to past the end of our parameters.
                 */
                ParametersIterator end_parameters() const
                {
                    return _parameters.end();
                }

                /**
                 * Do we have no parameters?
                 */
                bool empty() const
                {
                    return _parameters.empty();
                }

                /**
                 * Add an ArgsOption instance.
                 */
                void add_option(ArgsOption *opt, const std::string long_name, const char short_name = '\0')
                {
                    _longopts[long_name] = opt;
                    if (short_name != '\0')
                        _shortopts[short_name] = opt;
                }

        };

        /**
         * Output an ArgsHandler to an ostream, for --help output.
         *
         * \ingroup grplibpaludisargs
         */
        std::ostream & operator<< (std::ostream &, const ArgsHandler &);
    }
}

#endif