summaryrefslogtreecommitdiff
path: root/gpr/source/app/common/argument_parser/program_options_lite.h
blob: 901c816c0e5821ab4b2c2049e7fb039642437880 (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
/* The copyright in this software is being made available under the BSD
 * License, included below. This software may be subject to other third party
 * and contributor rights, including patent rights, and no such rights are
 * granted under this license.
 *
 * Copyright (c) 2010-2015, ITU/ISO/IEC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
 *    be used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
#include <iostream>
#include <sstream>
#include <string>
#include <list>
#include <map>

#ifndef __PROGRAM_OPTIONS_LITE__
#define __PROGRAM_OPTIONS_LITE__

namespace program_options_lite
{
    struct Options;
    
    struct ParseFailure : public std::exception
    {
        ParseFailure(std::string arg0, std::string val0) throw()
        : arg(arg0), val(val0)
        {}
        
        ~ParseFailure() throw() {};
        
        std::string arg;
        std::string val;
        
        const char* what() const throw() { return "Option Parse Failure"; }
    };
    
    void doHelp(std::ostream& out, Options& opts, unsigned columns = 80);
    unsigned parseGNU(Options& opts, unsigned argc, const char* argv[]);
    unsigned parseSHORT(Options& opts, unsigned argc, const char* argv[]);
    std::list<const char*> scanArgv(Options& opts, unsigned argc, const char* argv[]);
    void scanLine(Options& opts, std::string& line);
    void scanFile(Options& opts, std::istream& in);
    void setDefaults(Options& opts);
    void parseConfigFile(Options& opts, const std::string& filename);
    bool storePair(Options& opts, const std::string& name, const std::string& value);
    
    /** OptionBase: Virtual base class for storing information relating to a
     * specific option This base class describes common elements.  Type specific
     * information should be stored in a derived class. */
    struct OptionBase
    {
        OptionBase(const std::string& name, const std::string& desc)
        : opt_string(name), opt_desc(desc)
        {};
        
        virtual ~OptionBase() {}
        
        /* parse argument arg, to obtain a value for the option */
        virtual void parse(const std::string& arg) = 0;
        /* set the argument to the default value */
        virtual void setDefault() = 0;
        
        std::string opt_string;
        std::string opt_desc;
    };
    
    /** Type specific option storage */
    template<typename T>
    struct Option : public OptionBase
    {
        Option(const std::string& name, T& storage, T default_val, const std::string& desc)
        : OptionBase(name, desc), opt_storage(storage), opt_default_val(default_val)
        {}
        
        void parse(const std::string& arg);
        
        void setDefault()
        {
            opt_storage = opt_default_val;
        }
        
        T& opt_storage;
        T opt_default_val;
    };
    
    /* Generic parsing */
    template<typename T>
    inline void
    Option<T>::parse(const std::string& arg)
    {
        std::istringstream arg_ss (arg,std::istringstream::in);
        arg_ss.exceptions(std::ios::failbit);
        try
        {
            arg_ss >> opt_storage;
        }
        catch (...)
        {
            throw ParseFailure(opt_string, arg);
        }
    }
    
    /* string parsing is specialized -- copy the whole string, not just the
     * first word */
    template<>
    inline void
    Option<std::string>::parse(const std::string& arg)
    {
        opt_storage = arg;
    }
    
    /** Option class for argument handling using a user provided function */
    struct OptionFunc : public OptionBase
    {
        typedef void (Func)(Options&, const std::string&);
        
        OptionFunc(const std::string& name, Options& parent_, Func *func_, const std::string& desc)
        : OptionBase(name, desc), parent(parent_), func(func_)
        {}
        
        void parse(const std::string& arg)
        {
            func(parent, arg);
        }
        
        void setDefault()
        {
            return;
        }
        
    private:
        Options& parent;
        void (*func)(Options&, const std::string&);
    };
    
    class OptionSpecific;
    struct Options
    {
        ~Options();
        
        OptionSpecific addOptions();
        
        struct Names
        {
            Names() : opt(0) {};
            ~Names()
            {
                if (opt)
                {
                    delete opt;
                }
            }
            std::list<std::string> opt_long;
            std::list<std::string> opt_short;
            OptionBase* opt;
        };
        
        void addOption(OptionBase *opt);
        
        typedef std::list<Names*> NamesPtrList;
        NamesPtrList opt_list;
        
        typedef std::map<std::string, NamesPtrList> NamesMap;
        NamesMap opt_long_map;
        NamesMap opt_short_map;
    };
    
    /* Class with templated overloaded operator(), for use by Options::addOptions() */
    class OptionSpecific
    {
    public:
        OptionSpecific(Options& parent_) : parent(parent_) {}
        
        /**
         * Add option described by name to the parent Options list,
         *   with storage for the option's value
         *   with default_val as the default value
         *   with desc as an optional help description
         */
        template<typename T>
        OptionSpecific&
        operator()(const std::string& name, T& storage, T default_val, const std::string& desc = "")
        {
            parent.addOption(new Option<T>(name, storage, default_val, desc));
            return *this;
        }
        
        /**
         * Add option described by name to the parent Options list,
         *   with desc as an optional help description
         * instead of storing the value somewhere, a function of type
         * OptionFunc::Func is called.  It is upto this function to correctly
         * handle evaluating the option's value.
         */
        OptionSpecific&
        operator()(const std::string& name, OptionFunc::Func *func, const std::string& desc = "")
        {
            parent.addOption(new OptionFunc(name, parent, func, desc));
            return *this;
        }
    private:
        Options& parent;
    };
    
} /* namespace: program_options_lite */


#endif // __PROGRAM_OPTIONS_LITE__