src/optparse/optparse.h

Go to the documentation of this file.

/*
 * optparse.h
 *
 * An option parser for C++ modeled after the optparse Python
 * module. Create an instance of OptionParser in your program
 * and you can add options to it then call the method
 * parse_args with argc and argv and it will parse them. The
 * '-h' and '--help' options are built in, they print the
 * usage message.
 *
 * W. Evan Sheehan <evan_sheehan@nrel.gov>
 *
 */

#ifndef OPTPARSE_H
#define OPTPARSE_H

#include <map>
#include <vector>
#include <string>
#include <sstream>
#include <stdexcept>

namespace optparse {

typedef enum {STORE_FALSE=0, STORE_TRUE, STORE} action_t;

typedef enum {STRING=0, BOOL, INT, DOUBLE} type_t;

class Option {
public:
    Option (std::string shrt, std::string lng, std::string dest,
            std::string hlp, action_t act, std::string dfault, type_t type,
            std::string allowed_args);
    ~Option ();
    
    bool is_allowed(std::string argument);

    action_t action;            // define what we store
    std::string shrt_flag;      // short flag, something like -o
    std::string lng_flag;       // long flag, something like --outfile
    std::string help;           // help message about the option
    std::string destination;    // the key used to store this option in the parser.
    std::string dfault_;
    type_t type_;
    std::string allowed_args_;        
};

class OptionError : public std::runtime_error {
public:
    OptionError(std::string option, std::string error_msg)
            : std::runtime_error("") {
        std::ostringstream str;
        str << "OptionParser error: option: " << option << ", cause: " << error_msg;
        msg_ = str.str();
    }
    virtual ~OptionError() throw() {}
    virtual const char* what() const throw() { return msg_.c_str(); }
protected:
    std::string msg_;
};

class OptionParser {
public:
    OptionParser (std::string usage="");
    virtual ~OptionParser ();

    void add_option (std::string shrt_flag, std::string lng_flag,
                     std::string destination, std::string help="", action_t act=STORE,
                     type_t type=STRING, std::string dfault="",
                     std::string allowed_values="");

    /* Parse the commandline args. */
    void parse_args (int argc, char **argv);
    void help (std::ostream& os);
    std::string type2string(type_t type);
    typedef std::map<std::string, std::string> options_type;
    options_type options;                   
    std::vector<std::string> arguments;     

protected:
    virtual void set_option(Option& option, std::string argument);

private:
    std::string use_msg;            
    std::vector<Option> opts;       

    /* Helper for finding which Option (if any) argv[index] matches. */
    void find_opt_short(int argc, char **argv, int &index);
    void find_opt_long(int argc, char **argv, int &index);
};

} // namespace optparse

#endif

---