Skip to content

Latest commit

 

History

History
executable file
·
211 lines (153 loc) · 6.09 KB

README.md

File metadata and controls

executable file
·
211 lines (153 loc) · 6.09 KB
Raw

Overview

ezOptionParser is another command-line parser class for C++ that has features not available in alternative solutions (getopt, boost, argtable, argstream, gflags) and doesn't require a steep learning curve.

Download

Source Code and Examples

ezOptionParser.hpp

Features

  • Pretty printing of parsed inputs for debugging.
  • Auto usage message creation in three layouts (aligned, interleaved or staggered).
  • Single header file implementation.
  • Dependent only on STL.
  • Arbitrary short and long option names (dash '-' or plus '+' prefixes not required).
  • Arbitrary argument list delimiters.
  • Multiple flag instances allowed.
  • Validation of required options, number of expected arguments per flag, datatype ranges, user defined ranges, membership in lists and case for string lists.
  • Validation criteria definable by strings or constants.
  • Multiple file import with comments.
  • Exports to file, either set options or all options including defaults when available.
  • Option parse index for order dependent contexts.
  • MIT license.
  • Minimal learning curve due to many examples.
  • Automated regression and memory tests with valgrind.

Examples

complete.cpp A complete example that could be used as a starting point for your own C++ program.

fileio.cpp Shows how to import and export options with files (that can contain comments!).

full.cpp A full test of all the features. Meant for testing, but can be a source of ideas for what's possible.

long.cpp Demo of using long flag names.

multi.cpp Shows how to handle multiple instances of a flag.

parseindex.cpp Demo of parsed indices for options, so you can create ordered contexts.

pretty.cpp Demo of pretty printing everything parsed, which can help in debugging.

short.cpp Short demo of a short flag name.

usage.cpp Demo of automatic usage message creation in three builtin layouts. Here are how the three layouts appear: aligned, interleaved, staggered

valid.cpp Demo of using validators defined by strings, which only check if values are within for their datatype limits.

validrange.cpp Demo of using validators with value ranges and lists defined by strings.

validfast.cpp Demo of using validators defined by constants for more efficient execution. These validators only check if values are within for their datatype limits..

validrangefast.cpp Demo of using validators with value ranges and lists defined by constants for more efficient execution.

Usage

Copy or include ezOptionParser.hpp to your project and use the "ez" namespace, as shown here:

// pretty.cpp
#include <stdio.h>
#include "ezOptionParser.hpp"

int main(int argc, const char * argv[]) {
  ez::ezOptionParser opt;

  opt.overview = "Demo of pretty printing everything parsed.";
  opt.syntax = "pretty [OPTIONS]";
  opt.example = "pretty foo bar --debug --dummy -list 1,2,16 in1 in2 out\n\n";
  opt.footer = "ezOptionParser (C) 2013\n";
  
  opt.add(
    "", // Default.
    0, // Required?
    0, // Number of args expected.
    0, // Delimiter if expecting multiple args.
    "Display usage instructions.", // Help description.
    "-h",     // Flag token. 
    "-help",  // Flag token.
    "--help", // Flag token.
    "--usage" // Flag token.
  );

  opt.add(
    "", // Default.
    0, // Required?
    0, // Number of args expected.
    0, // Delimiter if expecting multiple args.
    "Print all inputs and categories for debugging.", // Help description.
    "--debug"     // Flag token. 
  );

  opt.parse(argc, argv);

  if (opt.isSet("-h")) {
  	std::string usage;
    opt.getUsage(usage);
    std::cout << usage;
    return 1;
  }
  
  if (opt.isSet("--debug")) {
    std::string pretty;
    opt.prettyPrint(pretty);
    std::cout << pretty;
  }

  return 0;
}

Here is the auto-generated usage message:

./pretty -h
Demo of pretty printing everything parsed.

USAGE: pretty [OPTIONS]

OPTIONS:

-h, -help, --help, --usage   Display usage instructions.

--debug                      Print all inputs and categories for debugging.

EXAMPLES:

pretty foo bar --debug --dummy -list 1,2,16 in1 in2 out

ezOptionParser (C) 2013

Testing

make
make memtest
make clean

Installation

sudo make install PREFIX=/usr/local

Distribution

make html
make clean
make dist VER=0.2.1

Publishing

ssh -t rsz,[email protected] create 
scp html/* ezOptionParser.hpp rsz,[email protected]:/home/project-web/ezoptionparser/htdocs
scp ../ezOptionParser-0.2.1.tar.gz rsz,[email protected]:/home/frs/project/e/ez/ezoptionparser

Changelog

v0.2.1 (20130506)

  • Added a toggle to disable extra line break between OPTIONS usage descriptions (opts->doublespace = 0;). This will pack the descriptions together like traditional usage messages, so you can see more per page.

v0.2.0 (20121120)

  • Added parse index to options. Thanks to Michael Lachmann for the idea.

v0.1.4 (20120629)

  • Fixed file licenses to MIT.

v0.1.3 (20120603)

  • Changed license to MIT.
  • Reformatted readme to markdown.
  • Updated make dist target to be git friendly.

v0.1.2 (20111126)

  • Published.

v0.1.1 (20111011)

  • Published.

v0.1.0 (20111011)

  • Published.

v0.0.0 (20110511)

  • Published.

License

Copyright 2011, 2012 Remik Ziemlinski (see MIT-LICENSE)

<script src="http://yandex.st/highlightjs/7.0/highlight.min.js"></script> <script>hljs.initHighlightingOnLoad();</script>