args

This library is considered feature-complete by its creator. It will still receive bug fixes, and good pull requests will be accepted, but no new major functionality or API changes will be added to this codebase.

A simple, small, flexible, single-header C++11 argument parsing library.

This is designed to appear somewhat similar to Python's argparse, but in C++, with static type checking, and hopefully a lot faster (also allowing fully nestable group logic, where Python's argparse does not).

UTF-8 support is limited at best. No normalization is performed, so non-ascii characters are very best kept out of flags, and combined glyphs are probably going to mess up help output if you use them. Most UTF-8 necessary for internationalization should work for most cases, though heavily combinatory UTF alphabets may wreak havoc.

This program is MIT-licensed, so you can use the header as-is with no restrictions. I'd appreciate attribution in a README, Man page, or something if you are feeling generous, but all that's required is that you don't remove the license and my name from the header of the args.hxx file in source redistributions (ie. don't pretend that you wrote it). I do welcome additions and updates wherever you feel like contributing code.

The API documentation can be found at https://taywee.github.io/args

The code can be downloaded at https://github.com/Taywee/args

There are also somewhat extensive examples below.

You can find the complete test cases at https://github.com/Taywee/args/blob/master/test.cxx, which should very well describe the usage, as it's built to push the boundaries.

What does it do?

It:

Lets you handle flags, flag+value, and positional arguments simply and elegantly, with the full help of static typechecking.
Allows you to use your own types in a pretty simple way.
Lets you use count flags, and lists of all argument-accepting types.
Allows full validation of groups of required arguments, though output isn't pretty when something fails group validation. User validation functions are accepted. Groups are fully nestable.
Generates pretty help for you, with some good tweakable parameters.
Lets you customize all prefixes and most separators, allowing you to create an infinite number of different argument syntaxes.
Lets you parse, by default, any type that has a stream extractor operator for it. If this doesn't work for your uses, you can supply a function and parse the string yourself if you like.
Lets you decide not to allow separate-argument value flags or joined ones (like disallowing --foo bar, requiring --foo=bar, or the inverse, or the same for short options).
Allows you to create subparsers, to reuse arguments for multiple commands and to refactor your command's logic to a function or lambda.
Allows one value flag to take a specific number of values (like --foo first second, where --foo slurps both arguments).
Allows you to have value flags only optionally accept values.
Provides autocompletion for bash.

What does it not do?

There are tons of things this library does not do!

It will not ever:

Allow you to intermix multiple different prefix types (eg. ++foo and --foo in the same parser), though shortopt and longopt prefixes can be different.
Allow you to make flags sensitive to order (like gnu find), or make them sensitive to relative ordering with positionals. The only orderings that are order-sensitive are:
- Positionals relative to one-another
- List positionals or flag values to each of their own respective items
Allow you to use a positional list before any other positionals (the last argument list will slurp all subsequent positional arguments). The logic for allowing this would be a lot more code than I'd like, and would make static checking much more difficult, requiring us to sort std::string arguments and pair them to positional arguments before assigning them, rather than what we currently do, which is assigning them as we go for better simplicity and speed. The library doesn't stop you from trying, but the first positional list will slurp in all following positionals

How do I install it?

sudo make install

Or, to install it somewhere special (default is /usr/local):

sudo make install DESTDIR=/opt/mydir

You can also copy the file into your source tree, if you want to be absolutely sure you keep a stable API between projects.

If you prefer other installation methods, many standard ones are available and included, including CMake, conan, buck, and meson. An example CMake file using args is included in the examples directory.

I also want man pages.

make doc/man
sudo make installman

This requires Doxygen

I want the doxygen documentation locally

doxygen Doxyfile

Your docs are now in doc/html

How to depend on it using tipi.build?

Simply add the following entry to your .tipi/deps file

{
    "taywee/args": { "@": "6.4.1" }
}

You can optionally remove the @ section to target HEAD easily.

How do I use it?

Create an ArgumentParser, modify its attributes to fit your needs, add arguments through regular argument objects (or create your own), and match them with an args::Matcher object (check its construction details in the doxygen documentation.

Then you can either call it with args::ArgumentParser::ParseCLI for the full command line with program name, or args::ArgumentParser::ParseArgs with just the arguments to be parsed. The argument and group variables can then be interpreted as a boolean to see if they've been matched.

All variables can be pulled (including the boolean match status for regular args::Flag variables) with args::get.

Group validation is weird. How do I get more helpful output for failed validation?

This is unfortunately not possible, given the power of the groups available. For instance, if you have a group validation that works like (A && B) || (C && (D XOR E)), how is this library going to be able to determine what exactly when wrong when it fails? It only knows that the entire expression evaluated false, not specifically what the user did wrong (and this is doubled over by the fact that validation operations are ordinary functions without any special meaning to the library). As you are the only one who understands the logic of your program, if you want useful group messages, you have to catch the ValidationError as a special case and check your own groups and spit out messages accordingly.

Is it developed with regression tests?

Yes. tests.cxx in the git repository has a set of standard tests (which are still relatively small in number, but I would welcome some expansion here), and thanks to Travis CI and AppVeyor, these tests run with every single push:

% make runtests
g++ test.cxx -o test.o -I. -std=c++11 -O2 -c -MMD
g++ -o test test.o -std=c++11 -O2
./test
===============================================================================
All tests passed (74 assertions in 15 test cases)

%

The testing library used is Catch.

Examples

All the code examples here will be complete code examples, with some output.

Simple example:

#include <iostream>
#include <args.hxx>
int main(int argc, char **argv)
{
    args::ArgumentParser parser("This is a test program.", "This goes after the options.");
    args::HelpFlag help(parser, "help", "Display this help menu", {'h', "help"});
    args::CompletionFlag completion(parser, {"complete"});
    try
    {
        parser.ParseCLI(argc, argv);
    }
    catch (const args::Completion& e)
    {
        std::cout << e.what();
        return 0;
    }
    catch (const args::Help&)
    {
        std::cout << parser;
        return 0;
    }
    catch (const args::ParseError& e)
    {
        std::cerr << e.what() << std::endl;
        std::cerr << parser;
        return 1;
    }
    return 0;
}

 % ./test
 % ./test -h
  ./test {OPTIONS} 

    This is a test program. 

  OPTIONS:

      -h, --help         Display this help menu 

    This goes after the options. 
 %

Boolean flags, special group types, different matcher construction:

#include <iostream>
#include <args.hxx>
int main(int argc, char **argv)
{
    args::ArgumentParser parser("This is a test program.", "This goes after the options.");
    args::Group group(parser, "This group is all exclusive:", args::Group::Validators::Xor);
    args::Flag foo(group, "foo", "The foo flag", {'f', "foo"});
    args::Flag bar(group, "bar", "The bar flag", {'b'});
    args::Flag baz(group, "baz", "The baz flag", {"baz"});
    try
    {
        parser.ParseCLI(argc, argv);
    }
    catch (args::Help)
    {
        std::cout << parser;
        return 0;
    }
    catch (args::ParseError e)
    {
        std::cerr << e.what() << std::endl;
        std::cerr << parser;
        return 1;
    }
    catch (args::ValidationError e)
    {
        std::cerr << e.what() << std::endl;
        std::cerr << parser;
        return 1;
    }
    if (foo) { std::cout << "foo" << std::endl; }
    if (bar) { std::cout << "bar" << std::endl; }
    if (baz) { std::cout << "baz" << std::endl; }
    return 0;
}

 % ./test   
Group validation failed somewhere!
  ./test {OPTIONS} 

    This

Args

Install / Use

README