README.md

Simple C++ option parser

This library is used for option parsing and can be used in any C++ command line software. The option parser uses only string options, and conversions have to be made when integer or floating values are wanted. This choice has been made so that the parser is the same as the python option parser, and the operator [] can be used to acess the option values after the parsing.

Each option is represented by a small and a long name, and is also given at declaration a description and a default value. The short name, respectively the long name, is recognised on command line only if preceded by a -, respectively a --. Once the command line has been parsed by the option parser, the options are accessible with the [] operator.

Here is a short code to illustrate how to use library.

// C++ OPTION PARSER TOOL

#include <iostream>
#include "optionParser.hpp"

using namespace std;



int main(int argc, char* argv[]){

    // create a OptionParser with options
    op::OptionParser opt;
    opt.add_option("h", "help", "shows option help", false); // no default value means boolean options, which default value is false
    opt.add_option("w", "window_size", "window's size", "256", false);
    opt.add_option("r", "rate", "learning rate", "", true ); // true indicates the option is required
    opt.add_option("m", "mode", "learning mode", "random", false );

    // parse the options and verify that all went well. If not, errors and help will be shown
    bool correct_parsing = opt.parse_options(argc, argv);
    
    if(!correct_parsing){
        return EXIT_FAILURE;
    }

    cout << opt["rate"] << endl;
    cout << opt["w"] << endl;
    cout << opt["h"] << endl;
    
    // you have to convert yourself arguments if needed. This gives you full control over your options
    int window_size     =  op::str2int(opt["w"]);
    float learning_rate =  op::str2float(opt["r"]);
    bool has_help       =  op::str2bool(opt["h"]);

    // show help
    if(has_help) opt.show_help();
    
    return 0;
}