opts.h 9.79 KB
Newer Older
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 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
/**
 * Author: Dmitriy Morozov <dmitriy@mrzv.org>
 * The interface is heavily influenced by GetOptPP (https://code.google.com/p/getoptpp/).
 *
 * History:
 *  - 2015-06-01: added Traits<...>::type_string() for long, unsigned long
 */

#ifndef OPTS_OPTS_H
#define OPTS_OPTS_H

#include <iostream>
#include <sstream>
#include <string>
#include <list>
#include <vector>

namespace opts {

// Converters
template<class T>
struct Converter
{
                    Converter()                     {}
    static
    T               convert(const std::string& val) { std::istringstream iss(val); T res; iss >> res; return res; }
};

// Type
template<class T>
struct Traits
{
    static std::string  type_string()               { return "UNKNOWN TYPE"; }
};

template<>
struct Traits<int>
{
    static std::string  type_string()               { return "INT"; }
};

template<>
struct Traits<short int>
{
    static std::string  type_string()               { return "SHORT INT"; }
};

template<>
struct Traits<long>
{
    static std::string  type_string()               { return "LONG"; }
};

template<>
struct Traits<unsigned>
{
    static std::string  type_string()               { return "UNSIGNED INT"; }
};

template<>
struct Traits<short unsigned>
{
    static std::string  type_string()               { return "SHORT UNSIGNED INT"; }
};

template<>
struct Traits<unsigned long>
{
    static std::string  type_string()               { return "UNSIGNED LONG"; }
};

template<>
struct Traits<float>
{
    static std::string  type_string()               { return "FLOAT"; }
};

template<>
struct Traits<double>
{
    static std::string  type_string()               { return "DOUBLE"; }
};

template<>
struct Traits<std::string>
{
    static std::string  type_string()               { return "STRING"; }
};


struct BasicOption
{
                    BasicOption(char        s_,
                                std::string l_,
                                std::string default_,
                                std::string type_,
                                std::string help_):
                        s(s_), l(l_), d(default_), t(type_), help(help_)                    {}

    int             long_size() const                           { return l.size() + 1 + t.size(); }

    void            output(std::ostream& out, int max_long) const
    {
        out << "   ";
        if (s)
            out << '-' << s << ", ";
        else
            out << "    ";

        out << "--" << l << ' ';

        if (!t.empty())
            out << t;

        for (int i = long_size(); i < max_long; ++i)
            out <<  ' ';

        out << "   " << help;

        if (!d.empty())
        {
            out << " [default: " << d << "]";
        }
        out << '\n';
    }

    char            s;
    std::string     l;
    std::string     d;
    std::string     t;
    std::string     help;
};

// Option
template<class T>
struct OptionContainer: public BasicOption
{
                    OptionContainer(char               s_,
                                    const std::string& l_,
                                    T&                 var_,
                                    const std::string& help_,
                                    const std::string& type_ = Traits<T>::type_string()):
                        BasicOption(s_, l_, default_value(var_), type_, help_),
                        var(&var_)                  {}

    static
    std::string     default_value(const T& def)
    {
        std::ostringstream oss;
        oss << def;
        return oss.str();
    }

    void            parse(std::list<std::string>& args) const
    {
        std::string short_opt = "-"; short_opt += s;
        std::string long_opt  = "--" + l;
        for (std::list<std::string>::iterator cur = args.begin(); cur != args.end(); ++cur)
        {
            if (*cur == short_opt || *cur == long_opt)
            {
                cur = args.erase(cur);
                if (cur != args.end())
                {
                    *var = Converter<T>::convert(*cur);
                    cur = args.erase(cur);
                    break;              // finds first occurrence
                }
                else
                     break;         // if the last option's value is missing, it remains default

            }
        }
    }

    T*  var;
};

template<class T>
struct OptionContainer< std::vector<T> >: public BasicOption
{
                    OptionContainer(char               s_,
                                    const std::string& l_,
                                    std::vector<T>&    var_,
                                    const std::string& help_,
                                    const std::string& type_ = "SEQUENCE"):
                        BasicOption(s_, l_, default_value(var_), type_, help_),
                        var(&var_), first(true)             { }

    static
    std::string     default_value(const std::vector<T>& def)
    {
        std::ostringstream oss;
        oss << "(";
        if (def.size())
            oss << def[0];
        for (int i = 1; i < def.size(); ++i)
            oss << ", " << def[i];
        oss << ")";
        return oss.str();
    }

    void            parse(std::list<std::string>& args) const
    {
        std::string short_opt = "-"; short_opt += s;
        std::string long_opt  = "--" + l;
        for (std::list<std::string>::iterator cur = args.begin(); cur != args.end(); ++cur)
        {
            if (*cur == short_opt || *cur == long_opt)
            {
                if (first)
                {
                    var->clear();
                    first = false;
                }

                cur = args.erase(cur);
                if (cur != args.end())
                {
                    var->push_back(Converter<T>::convert(*cur));
                    cur = args.erase(cur);
                }
                --cur;
            }
        }
    }

    std::vector<T>* var;
    mutable bool    first;
};


template<class T>
OptionContainer<T>
Option(char s, const std::string& l, T& var, const std::string& help)       { return OptionContainer<T>(s, l, var, help); }

template<class T>
OptionContainer<T>
Option(char s, const std::string& l, T& var,
       const std::string& type, const std::string& help)                    { return OptionContainer<T>(s, l, var, help, type); }

template<class T>
OptionContainer<T>
Option(const std::string& l, T& var, const std::string& help)               { return OptionContainer<T>(0, l, var, help); }

template<class T>
OptionContainer<T>
Option(const std::string& l, T& var,
       const std::string& type, const std::string& help)                    { return OptionContainer<T>(0, l, var, help, type); }

// Present
struct PresentContainer: public BasicOption
{
                PresentContainer(char s, const std::string& l, const std::string& help):
                    BasicOption(s,l,"","",help)           {}
};

inline
PresentContainer
Present(char s, const std::string& l, const std::string& help)              { return PresentContainer(s, l, help); }

inline
PresentContainer
Present(const std::string& l, const std::string& help)                      { return PresentContainer(0, l, help); }

// PosOption
template<class T>
struct PosOptionContainer
{
                PosOptionContainer(T& var_):
                    var(&var_)                                              {}

    bool        parse(std::list<std::string>& args) const
    {
        if (args.empty())
            return false;

        *var = Converter<T>::convert(args.front());
        args.pop_front();
        return true;
    }

    T*          var;
};

template<class T>
PosOptionContainer<T>
PosOption(T& var)                                                           { return PosOptionContainer<T>(var); }


// Options
struct Options
{
            Options(int argc_, char** argv_):
                args(argv_ + 1, argv_ + argc_),
                failed(false)                       {}

    template<class T>
    Options&    operator>>(const OptionContainer<T>&  oc);
    bool        operator>>(const PresentContainer&    pc);
    template<class T>
    Options&    operator>>(const PosOptionContainer<T>& poc);

                operator bool()                     { return !failed; }


    friend
    std::ostream&
    operator<<(std::ostream& out, const Options& ops)
    {
        int max_long = 0;
        for (std::list<BasicOption>::const_iterator cur =  ops.options.begin();
                                                    cur != ops.options.end();
                                                  ++cur)
        {
            int cur_long = cur->long_size();
            if (cur_long > max_long)
                max_long = cur_long;
        }

        out << "Options:\n";
        for (std::list<BasicOption>::const_iterator cur =  ops.options.begin();
                                                    cur != ops.options.end();
                                                  ++cur)
            cur->output(out, max_long);

        return out;
    }


    private:
        std::list<std::string>                      args;
        std::list<BasicOption>                      options;
        bool                                        failed;
};

template<class T>
Options&
Options::operator>>(const OptionContainer<T>&  oc)
{
    options.push_back(oc);
    oc.parse(args);
    return *this;
}

inline
bool
Options::operator>>(const PresentContainer& pc)
{
    options.push_back(pc);

    for(std::list<std::string>::iterator cur = args.begin(); cur != args.end(); ++cur)
    {
        std::string short_opt = "-"; short_opt += pc.s;
        std::string long_opt  = "--" + pc.l;
        if (*cur == short_opt || *cur == long_opt)
        {
            args.erase(cur);
            return true;
        }
    }
    return false;
}

template<class T>
Options&
Options::operator>>(const PosOptionContainer<T>& poc)
{
    failed = !poc.parse(args);
    return *this;
}

}

#endif